1 /*

     2 * Copyright (c) 2008 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:  Declaration of interface MFscContactSet.

    15 *

    16 */

    17 

    18 

    19 #ifndef M_FSCCONTACTSET_H

    20 #define M_FSCCONTACTSET_H

    21 

    22 #include <e32base.h>

    23 #include <cntdef.h>

    24 

    25 #include "fsccontactactionservicedefines.h"

    26 

    27 // FORWARD DECLARATIONS

    28 class MFscContactSetObserver;

    29 class MVPbkContactLink;

    30 

    31 /**

    32  *  Contact set.

    33  *  Defines an interface for contact set.

    34  *

    35  *  @since S60 3.1

    36  */

    37 class MFscContactSet

    38     {

    39     

    40 public: //Contact related methods

    41     

    42     /**

    43      * Contact count.

    44      *

    45      * @return contact count.

    46      */

    47     virtual TInt ContactCount() const = 0;

    48     

    49     /**

    50      * Checks if iterator has more contacts.

    51      *

    52      * @return ETrue if the iterator has more contacts.

    53      */

    54     virtual TBool HasNextContact() const = 0;

    55     

    56     /**

    57      * Sets the iterator to point to the first contact in the list.

    58      */

    59     virtual void SetToFirstContact() = 0;

    60     

    61     /**

    62      * Asynchronous operation for retrieving store contact for contact. 

    63      *

    64      * @param aObserver operation observer. 

    65      */

    66     virtual void NextContactL( MFscContactSetObserver* aObserver ) = 0;

    67     

    68     /**

    69      * Returns link for contact.

    70      */

    71     virtual MVPbkContactLink* NextContactLinkL() = 0;

    72     

    73     /**

    74      * Used for canceling asynchronous NextContactL operation.

    75      */

    76     virtual void CancelNextContactL() = 0;

    77 

    78     

    79 public: // Contact group related methods

    80     

    81     /**

    82      * Group count.

    83      *

    84      * @return group count.

    85      */

    86     virtual TInt GroupCount() const = 0;

    87     

    88     /**

    89      * Checks if iterator has more groups.

    90      *

    91      * @return ETrue if the iterator has more groups. 

    92      */

    93     virtual TBool HasNextGroup() const = 0;

    94     

    95     /**

    96      * Sets the iterator to point to the first group in the list.

    97      */

    98     virtual void SetToFirstGroup() = 0;

    99     

   100     /**

   101      * Asynchronous operation for retrieving store contact for group.

   102      * 

   103      * @param aObserver operation observer.

   104      */

   105     virtual void NextGroupL( MFscContactSetObserver* aObserver ) = 0;

   106     

   107     /**

   108      * Returns link for group.

   109      */

   110     virtual MVPbkContactLink* NextGroupLinkL() = 0;

   111     

   112     /**

   113      * Used for canceling asynchronous NextGroupL operation.

   114      */

   115     virtual void CancelNextGroupL() = 0;

   116     

   117     /**

   118      * Contact count of group.

   119      *

   120      * @param aStoreContact Group

   121      * @return group item count

   122      */

   123     virtual TInt GroupContactCountL( MVPbkStoreContact& aStoreContact ) = 0;

   124     

   125     /**

   126      * Asynchronous operation for retrieving contact from group.

   127      *

   128      * @param aStoreContact group

   129      * @param aIndex contsct index

   130      * @param aObserver operation observer

   131      */

   132     virtual void GetGroupContactL( MVPbkStoreContact& aStoreContact, 

   133             TInt aIndex, MFscContactSetObserver* aObserver ) = 0;

   134     

   135 public:

   136     

   137     /**

   138      * Destructor.

   139      */

   140     virtual ~MFscContactSet() {}

   141     

   142     };

   143 

   144 #endif // M_FSCCONTACTSET_H