imsrv_plat/ximp_core_data_model_api/inc/ximpidentity.h
changeset 0 e6b17d312c8b
equal deleted inserted replaced
-1:000000000000 0:e6b17d312c8b
       
     1 /*
       
     2 * Copyright (c) 2006, 2007 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:  Interface for identity object.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef MXIMPFWIDENTITY_H
       
    19 #define MXIMPFWIDENTITY_H
       
    20 
       
    21 #include <e32std.h>
       
    22 #include <ximpbase.h>
       
    23 #include <ximpdatamodelifids.hrh>
       
    24 
       
    25 
       
    26 /**
       
    27  * Interface for identity object.
       
    28  *
       
    29  * Identity objects are used to identify
       
    30  * presentities, presentity groups and
       
    31  * presentity group members, XIMP framework
       
    32  * client applications etc. entities in
       
    33  * XIMP Framework.
       
    34  *
       
    35  * @ingroup ximpdatamodelapi
       
    36  * @since S60 v3.2
       
    37  */
       
    38 class MXIMPIdentity : public MXIMPBase
       
    39     {
       
    40 public:
       
    41 
       
    42     /** Interface ID for the MXIMPIdentity. */
       
    43     enum { KInterfaceId = XIMP_IF_ID_IDENTITY };
       
    44 
       
    45 
       
    46 public:
       
    47 
       
    48     /**
       
    49      * Public destructor.
       
    50      * Objects can be deleted through this interface.
       
    51      */
       
    52     virtual ~MXIMPIdentity() {}
       
    53 
       
    54 
       
    55 public:
       
    56 
       
    57 
       
    58     /**
       
    59      * Returns identity string.
       
    60      *
       
    61      * @return The identity string.
       
    62      */
       
    63     virtual const TDesC16& Identity() const = 0;
       
    64 
       
    65 
       
    66 
       
    67     /**
       
    68      * Sets identity.
       
    69      *
       
    70      * @param [in] aIdentity
       
    71      *        Identity string.
       
    72      *
       
    73      * @leave KErrNoMemory if failed to allocate memory.
       
    74      */
       
    75     virtual void SetIdentityL(
       
    76                 const TDesC16& aIdentity ) = 0;
       
    77 
       
    78     };
       
    79 
       
    80 
       
    81 #endif // MXIMPFWIDENTITY_H