1 /*

     2 * Copyright (c) 2006 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:   Mixinclass for session's context-related tasks and info

    15 *

    16 */

    17 

    18 

    19 #ifndef M_CATALOGS_CONTEXT_H

    20 #define M_CATALOGS_CONTEXT_H

    21 

    22 #include <e32cmn.h>

    23 

    24 /**

    25  *  Class for session's context-related tasks and info

    26  *

    27  *  Server-side class for context-related tasks and info

    28  *

    29  *  @since S60 3.2

    30  */

    31 class MCatalogsContext

    32     {

    33 

    34 public:

    35 

    36     /**

    37      * Function that returns uid which identifies the family id

    38      * of the client-session

    39      *

    40      * @since S60 3.2

    41      * @return TUid that identifies the family id

    42      */

    43     virtual TUid FamilyId() const = 0;

    44 

    45     /**

    46      * Function that returns sid of the client-process

    47      *

    48      * @since S60 3.2

    49      * @return TUid that identifies the family id

    50      */

    51     virtual TSecureId SecureId() const = 0;

    52 

    53     /**

    54      * Method for getting a provider-specific data for the

    55      * context for reading and/or modification. By default the data

    56      * is empty.

    57      *

    58      * @since S60 3.2

    59      * @param aProviderIndex Local index number of the provider.

    60      * @return Context data for the specified provider.

    61      */

    62     virtual RBuf8& ProviderDataL( TInt aProviderIndex ) = 0;

    63     

    64     /**

    65      * Function that returns the instance id of the client-session.

    66      * There may be multiple clients with the same family id and SID

    67      * (i.e. multiple instances of the same client) and in some cases

    68      * it's necessary to differentiate them. This id serves that purpose.

    69      * 

    70      * @return Instance id that differentiates clients using the same family uid

    71      */

    72     virtual TInt InstanceId() const = 0;

    73     

    74     };

    75 

    76 

    77 #endif // M_CATALOGS_CONTEXT_H