imsrv_plat/ximp_im_data_model_api/inc/imobjectfactory.h
changeset 0 e6b17d312c8b
equal deleted inserted replaced
-1:000000000000 0:e6b17d312c8b
       
     1 /*
       
     2 * Copyright (c) 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 IM Feature Plugin object factory.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef MIMOBJECTFACTORY_H
       
    19 #define MIMOBJECTFACTORY_H
       
    20 
       
    21 #include <ximpbase.h>
       
    22 #include <ximpidentity.h>
       
    23 #include <bamdesca.h>
       
    24 #include <imdatamodelifids.hrh>
       
    25 
       
    26 class MImGroupInfo;
       
    27 class MImConversationInfo;
       
    28 class MImInvitationInfo;
       
    29 class MImSearchInfo;
       
    30 
       
    31 /**
       
    32  * Interface for IM Feature Plugin IM object factory.
       
    33  *
       
    34  * IM object factory is used to instantiate
       
    35  * data objects declared in data model API.
       
    36  *
       
    37  * MImObjectFactory interface can be obtained from
       
    38  * MXIMPContext or MXIMPProtocolConnectionHost
       
    39  * interfaces.
       
    40  *
       
    41  * @ingroup imdatamodelapi
       
    42  * @since S60 
       
    43  */
       
    44 class MImObjectFactory : public MXIMPBase
       
    45     {
       
    46 public:
       
    47 
       
    48     /** Interface ID for the MImObjectFactory. */
       
    49     enum { KInterfaceId = IM_IF_ID_IM_OBJECT_FACTORY };
       
    50 
       
    51 
       
    52 protected:
       
    53 
       
    54     /**
       
    55      * Protected destructor.
       
    56      * Object instancies can't be deleted via this interface.
       
    57      */
       
    58     virtual ~MImObjectFactory() {}
       
    59 
       
    60 
       
    61 
       
    62 
       
    63 public: // Group and similar info object types
       
    64 
       
    65 
       
    66     /**
       
    67      * Instantiates new IM group info object.
       
    68      *
       
    69      * @return New IM group info object instance.
       
    70      *         Object ownership is returned to caller.
       
    71      *
       
    72      * @leave KErrNoMemory if failed to allocate memory.
       
    73      */
       
    74     //virtual MImGroupInfo* NewImGroupInfoLC() = 0;
       
    75 
       
    76 
       
    77     /**
       
    78      * Instantiates new im conversation info object.
       
    79      *
       
    80      * @return new im conversation info object instance.
       
    81      *         Object ownership is returned to caller.
       
    82      *
       
    83      * @leave KErrNoMemory if failed to allocate memory.
       
    84      */
       
    85     virtual MImConversationInfo* NewImConversationInfoLC() = 0;
       
    86 
       
    87 
       
    88     /**
       
    89      * Instantiates new im invitation info object.
       
    90      *
       
    91      * @return new im invitation info object instance.
       
    92      *         Object ownership is returned to caller.
       
    93      *
       
    94      * @leave KErrNoMemory if failed to allocate memory.
       
    95      */
       
    96     //virtual MImInvitationInfo* NewImInvitationInfoLC() = 0;
       
    97 
       
    98 
       
    99     /**
       
   100      * Instantiates new im search info object.
       
   101      *
       
   102      * @return im search info info object instance.
       
   103      *         Object ownership is returned to caller.
       
   104      *
       
   105      * @leave KErrNoMemory if failed to allocate memory.
       
   106      */
       
   107     //virtual MImSearchInfo* NewImSearchInfoLC() = 0;
       
   108 
       
   109     };
       
   110 
       
   111 
       
   112 
       
   113 #endif // MIMOBJECTFACTORY_H
       
   114 
       
   115 
       
   116