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:  Item parent interface.

    15 *

    16 */

    17 

    18 #ifndef CXIMPITEMPARENT_H

    19 #define CXIMPITEMPARENT_H

    20 

    21 #include <ximpitemparentbase.h>

    22 

    23 class COwnPresenceSubscriptionItem;

    24 class CGroupListSubscriptionItem;

    25 class CGroupContentSubscriptionItem;

    26 class CPresentityPresenceSubscriptionItem;

    27 class CPresentityGroupMembersPresenceSubscriptionItem;

    28 class CWatcherListSubscriptionItem;

    29 class CGrantRequestListSubscriptionItem;

    30 //class CXIMPSubscriptionItemBase;

    31 class CXIMPApiEventBase;

    32 class MXIMPPscContext;

    33 class CXIMPIdentityImp;

    34 class CPresenceConfigurationItem;

    35 class CGroupMembersPresenceConfigurationItem;

    36 class CXIMPConfigurationItemBase;

    37 class CBlockListSubscriptionItem;

    38 class CPresenceToEveryoneConfigurationItem;

    39 class MPresenceCacheWriter;

    40 

    41 // FIX ME

    42 #define PRESENCE_ITEM_PARENT	0xE0000009

    43 

    44 /**

    45  * Item parent interface.

    46  *

    47  * @since S60 v3.2

    48  */

    49 class MXIMPItemParent : public MXIMPItemParentBase

    50     {

    51 	public:

    52 		enum { KInterfaceId = PRESENCE_ITEM_PARENT};

    53     

    54 public: // Definitions

    55 

    56     /**

    57      * Remove item

    58      * @param aChild Item pointer to remove.

    59      */

    60     virtual void RemoveMe( COwnPresenceSubscriptionItem* aChild ) = 0;

    61     virtual void RemoveMe( CGroupListSubscriptionItem* aChild ) = 0;

    62     virtual void RemoveMe( CGroupContentSubscriptionItem* aChild ) = 0;

    63     virtual void RemoveMe( CPresentityPresenceSubscriptionItem* aChild ) = 0;

    64     virtual void RemoveMe( CWatcherListSubscriptionItem* aChild ) = 0;

    65     virtual void RemoveMe( CPresentityGroupMembersPresenceSubscriptionItem* aChild ) = 0;

    66     virtual void RemoveMe( CGrantRequestListSubscriptionItem* aChild ) = 0;

    67     virtual void RemoveMe( CBlockListSubscriptionItem* aChild ) = 0;

    68 

    69     virtual void RemoveMe( CPresenceConfigurationItem* aChild ) = 0;

    70     virtual void RemoveMe( CPresenceToEveryoneConfigurationItem* aChild ) = 0;

    71     virtual void RemoveMe( CGroupMembersPresenceConfigurationItem* aChild ) = 0;

    72 

    73     /**

    74      * Add event

    75      */

    76     virtual void AddEventL( CXIMPApiEventBase& aEvent, MXIMPPscContext* aContext ) = 0;

    77 

    78     /**

    79      * Register item for expiration purposes.

    80      */   

    81     //virtual void RegisterExpiringItemL( CXIMPSubscriptionItemBase* aExpireItem ) = 0;

    82     

    83     /**

    84      * Unregister item from expiration purposes.

    85      */

    86     //virtual void UnregisterExpiringItem( CXIMPSubscriptionItemBase* aExpireItem ) = 0;

    87     

    88     /**

    89      * Add item as subscriber for presentity presence.

    90      */

    91     virtual void AddPresentityPresenceSubscriberL( const CXIMPIdentityImp& aIdentity, CXIMPSubscriptionItemBase* aItem, CXIMPIdentityImp* aGroup = NULL ) = 0;

    92 

    93     /**

    94      * Remove item from subscribing presentity presence.

    95      */

    96     virtual void RemovePresentityPresenceSubscriber( const CXIMPIdentityImp& aIdentity, CXIMPSubscriptionItemBase* aItem ) = 0;

    97     

    98     /**

    99      * Activate item for subscribing presentity presence

   100      */

   101     virtual void ActivatePresentityPresenceSubscriberL( const CXIMPIdentityImp& aIdentity, CXIMPSubscriptionItemBase* aItem ) = 0;

   102 

   103     /**

   104      * Synthesise presentity presence subscription event

   105      */    

   106     virtual void SynthesisePresentityPresenceSubscriptionEventToL( const CXIMPIdentityImp& aIdentity, MXIMPPscContext* aContext, TBool aForceEvent ) = 0;

   107 

   108     /**

   109      * Add item as configurator for presentity presence.

   110      */

   111     virtual void AddPresenceConfiguratorL( const CXIMPIdentityImp& aIdentity, CXIMPConfigurationItemBase* aItem ) = 0;

   112 

   113     /**

   114      * Remove item from configuring presentity presence.

   115      */

   116     virtual void RemovePresenceConfigurator( const CXIMPIdentityImp& aIdentity, CXIMPConfigurationItemBase* aItem ) = 0;

   117     

   118     /**

   119      * Return the protocol ID of the host of the parent

   120      */

   121     virtual TInt32 ProtocolUID( ) = 0;

   122 

   123     /**

   124      * Return the global presence cache object

   125      */

   126     virtual MPresenceCacheWriter* ExternalCache( ) = 0;

   127     

   128 protected: // Destruction

   129     

   130     /**

   131      * Object cannot be delted through this interface

   132      */

   133     virtual ~MXIMPItemParent(){}

   134     };

   135 

   136 /* ======================================================================== */

   137 

   138 

   139 

   140 #endif // CXIMPITEMPARENT_H