1 /*

     2 * Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Stored group data interface

    15 *

    16 */

    17 

    18 

    19 #ifndef MCASTOREDGROUP_H

    20 #define MCASTOREDGROUP_H

    21 

    22 #include <e32std.h>

    23 #include <badesca.h>

    24 

    25 #include "TStorageManagerGlobals.h"

    26 

    27 // FORWARD DECLARATIONS

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32  *  Interface for stored groups.

    33  *

    34  *  @lib CAStorage.dll

    35  *  @since 2.1

    36  */

    37 class MCAStoredGroup

    38     {

    39     public: // Interface

    40 

    41         /**

    42          * Check if the user has joined this group

    43          * @since 2.1

    44          * @return ETrue if the group has been joined

    45          */

    46         virtual TBool IsJoined() const = 0;

    47 

    48         /**

    49          * Get the User Ids of all members of the group. Result set is called

    50          * "members" and is the union of participants, administrators and

    51          * moderators. Makes copies of the descriptors.

    52          * @since 2.1

    53          * @param aMemberList The list of members

    54          */

    55         virtual void GetMembersL( CDesCArray& aMemberList ) const = 0;

    56 

    57         /**

    58          * Get the User Ids of participants of the group (joined users)

    59          * Makes copies of the descriptors.

    60          * @since 2.1

    61          * @param aParticipantList

    62          */

    63         virtual void GetParticipantsL( CDesCArray& aParticipantList ) const = 0;

    64 

    65         /**

    66          * Get the Group Id associated with this group.

    67          * @since 2.1

    68          * @return The group id, or KNullDesC if not set.

    69          */

    70         virtual const TDesC& GroupId() const = 0;

    71 

    72         /**

    73          * Get the Group Name associated with this group.

    74          * @since 2.1

    75          * @return The group name, or KNullDesC if not set.

    76          */

    77         virtual const TDesC& GroupName() const = 0;

    78 

    79         /**

    80          * Get the storage type of this group

    81          * @since 2.1

    82          * @return The storage type of this group

    83          */

    84         virtual TStorageManagerGlobals::TCAStorageType StorageType() const = 0;

    85 

    86         /**

    87          * See if this is the user's group

    88          * @since 2.1

    89          * @return ETrue if this group is the user's group

    90          */

    91         virtual TBool IsOwnGroup() const = 0;

    92 

    93         /**

    94          * Check if the user is administrator in this group

    95          * @return ETrue if the user is administrator

    96          * @since 2.1

    97          */

    98         virtual TBool IsAdmin() const = 0;

    99 

   100         /**

   101          * Get number of participants

   102          * @return The number of participants (joined normal users)

   103          * @since 2.1

   104          */

   105         virtual TInt NumParticipants() const = 0;

   106 

   107         /**

   108          * Check if the group is visible in UI or not

   109          * @return ETrue if the group is visible

   110          * @since 2.1

   111          */

   112         virtual TBool IsVisible() const = 0;

   113 

   114         /**

   115          * Return the server of this group

   116          * @return The server

   117          * @since 2.1

   118          */

   119         virtual const TDesC& Server() const = 0;

   120     };

   121 

   122 #endif      // MCASTOREDGROUP_H

   123 

   124 // End of File