ncdengine/provider/protocol/inc/ncd_pp_embeddeddata.h
changeset 4 32704c33136d
equal deleted inserted replaced
-1:000000000000 4:32704c33136d
       
     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:   MNcdPreminetProtocolEmbeddedData declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef NCD_PREMINET_PROTOCOL_EMBEDDEDDATA_H
       
    20 #define NCD_PREMINET_PROTOCOL_EMBEDDEDDATA_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 class MNcdPreminetProtocolDataEntity;
       
    25 
       
    26 class MNcdPreminetProtocolEmbeddedData
       
    27     {
       
    28 public:
       
    29 
       
    30     /**
       
    31      * Destructor
       
    32      */
       
    33     virtual ~MNcdPreminetProtocolEmbeddedData() {}
       
    34 
       
    35     /**
       
    36      * Returns the ID of the parent entity.
       
    37      * This entity should be added to the parent's child list,
       
    38      * @return Parent id or KNullDesC if parentless.
       
    39      */
       
    40     virtual const TDesC& ParentId() const = 0;
       
    41     
       
    42     /**
       
    43      * Returns the ID of this entity.
       
    44      * @return Id
       
    45      */
       
    46     virtual const TDesC& Id() const = 0;
       
    47 
       
    48     /**
       
    49      * Returns the last modified date for this entity.
       
    50      * @return Last modified time, or 0 if never modified.
       
    51      */
       
    52     virtual const TDesC& TimeStamp() const = 0;
       
    53 
       
    54     /**
       
    55      * Returns the namespace for this entity
       
    56      * @return namespace or KNullDesC 
       
    57      */
       
    58     virtual const TDesC& NameSpace() const = 0;
       
    59 
       
    60     /**
       
    61      * Returns the query ids related to this entity.
       
    62      * The array may be empty.
       
    63      * @return Query id array
       
    64      */
       
    65     virtual const TDesC& Name() const = 0;
       
    66     
       
    67     /**
       
    68      * The amount of data entities.
       
    69      * @return Entity count
       
    70      */
       
    71     virtual TInt DataEntityCount() const = 0;
       
    72     
       
    73     /**
       
    74      * Data entity.
       
    75      * @param aIndex Index of data entity.
       
    76      * @return Data entity reference. Leaves if index is out of bounds.
       
    77      * @see DataEntityCount().
       
    78      */
       
    79     virtual const MNcdPreminetProtocolDataEntity& 
       
    80         DataEntityL(TInt aIndex) const = 0;
       
    81     };
       
    82 
       
    83 #endif