ncdengine/provider/protocol/inc/ncd_pp_localentity.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:   MNcdProtocolElementEntity declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef NcdPREMINEPROTOCOLLOCALENTITY_H
       
    20 #define NcdPREMINEPROTOCOLLOCALENTITY_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 class MNcdPreminetProtocolIcon;
       
    25 
       
    26 
       
    27 /**
       
    28  * Base interface for some entities
       
    29  */
       
    30 class MNcdPreminetProtocolLocalEntity
       
    31     {
       
    32 public:
       
    33     enum TLocalEntityType
       
    34         {
       
    35         EDataEntity
       
    36 //         EActionData,
       
    37 //         EPromoData
       
    38         };
       
    39 
       
    40     /**
       
    41      * Destructor
       
    42      */
       
    43     virtual ~MNcdPreminetProtocolLocalEntity() {}
       
    44 
       
    45     /**
       
    46      * Returns the type of this reference entity.
       
    47      * @return Type
       
    48      */
       
    49     virtual TLocalEntityType Type() const = 0;
       
    50 
       
    51     /**
       
    52      * Returns the ID of this entity.
       
    53      * @return Id
       
    54      */
       
    55     virtual const TDesC& Id() const = 0;
       
    56     /**
       
    57      * Returns the last modified date for this entity.
       
    58      * @return Last modified time, or 0 if never modified.
       
    59      */
       
    60     virtual const TTime TimeStamp() const = 0;
       
    61     /**
       
    62      * Returns the namespace for this entity
       
    63      * @return namespace or KNullDesC 
       
    64      */
       
    65     virtual const TDesC& NameSpace() const = 0;
       
    66 
       
    67     /**
       
    68      * Entity name, localized.
       
    69      * @return Name, never KNullDesC
       
    70      */
       
    71     virtual const TDesC& Name() const = 0;
       
    72 
       
    73     /**
       
    74      * Retuns the description for this entity, localized.
       
    75      * @return Description or KNullDesC
       
    76      */
       
    77     virtual const TDesC& Description() const = 0;
       
    78 
       
    79     /**
       
    80      * Returns icon information for the entity.
       
    81      * @return Icon info or null if icon not available.
       
    82      */
       
    83     virtual const MNcdPreminetProtocolIcon* Icon() const = 0;
       
    84     
       
    85     /**
       
    86      * Returns the disclaimer for the entity.
       
    87      * @return Disclaimer text or KNullDesC if no disclaimer.
       
    88      */
       
    89     virtual const TDesC& Disclaimer() const = 0;
       
    90 
       
    91     
       
    92 
       
    93     };
       
    94 
       
    95 
       
    96 #endif