ncdengine/provider/server/inc/ncdcommunicable.h
changeset 0 ba25891c3a9e
equal deleted inserted replaced
-1:000000000000 0:ba25891c3a9e
       
     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:   Contains CNcdCommunicable class
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef NCD_COMMUNICABLE_H
       
    20 #define NCD_COMMUNICABLE_H
       
    21 
       
    22 
       
    23 #include <e32def.h>
       
    24 #include "catalogscommunicable.h"
       
    25 
       
    26 
       
    27 /**
       
    28  * This class object provides additional functionality that
       
    29  * CCatalogsCommunicable objects may need. For example,
       
    30  * CCatalogsCommunicable class only concentrates on the sessions of
       
    31  * proxies and server objects. This class object provides
       
    32  * functions that can be used to check the general states 
       
    33  * of the server side objects.
       
    34  *
       
    35  * @lib ?library
       
    36  * @since S60 ?S60_version *** for example, S60 v3.0
       
    37  */
       
    38 class CNcdCommunicable: public CCatalogsCommunicable
       
    39 {
       
    40 public:
       
    41 
       
    42  /**
       
    43   * @param aObsolete Informs if the object should be set as obsolete.
       
    44   */
       
    45  void SetAsObsolete( TBool aObsolete );
       
    46 
       
    47  
       
    48  /**
       
    49   * @return TBool ETrue if the object in server side is obsolete and
       
    50   * should not be used in proxy side anymore.
       
    51   */
       
    52  TBool IsObsolete() const;
       
    53 
       
    54 
       
    55 protected:
       
    56 
       
    57     /**
       
    58      * Constructor
       
    59      */
       
    60     CNcdCommunicable();
       
    61 
       
    62     /**
       
    63      * Destructor
       
    64      * 
       
    65      * @note that instead of using delete, Close() should be called.
       
    66      */
       
    67     virtual ~CNcdCommunicable();
       
    68 
       
    69 
       
    70 private:
       
    71  // Prevent these if not implemented
       
    72  CNcdCommunicable( const CNcdCommunicable& aObject );
       
    73  CNcdCommunicable& operator =( const CNcdCommunicable& aObject );
       
    74 
       
    75 
       
    76 private: // data
       
    77 
       
    78     TBool iObsolete;
       
    79 
       
    80 };
       
    81 
       
    82 #endif // NCD_COMMUNICABLE_H