ncdengine/provider/protocol/inc/ncd_cp_cookie.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:   MNcdConfigurationProtocolCookie declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_NCDCONFIGURATIONPROTOCOLCOOKIE_H
       
    20 #define M_NCDCONFIGURATIONPROTOCOLCOOKIE_H
       
    21 
       
    22 #include <e32base.h>
       
    23 #include <e32std.h>
       
    24 
       
    25 /**
       
    26  * Cookie scope definitions
       
    27  */
       
    28 namespace NcdConfigurationProtocolCookieScopes
       
    29     {
       
    30     /**
       
    31      * Client-scope
       
    32      */
       
    33     _LIT( KClient, "client" );
       
    34     
       
    35     /**
       
    36      * SIM-scope
       
    37      */
       
    38     _LIT( KSim, "sim" );
       
    39     }
       
    40 
       
    41 
       
    42 /**
       
    43  * Cookie type definitions
       
    44  */
       
    45 namespace NcdConfigurationProtocolCookieTypes
       
    46     {
       
    47     /**
       
    48      * Save
       
    49      */
       
    50     _LIT( KSave, "save" );
       
    51     
       
    52     /**
       
    53      * Save and send
       
    54      */
       
    55     _LIT( KSaveAndSend, "saveAndSend" );
       
    56     
       
    57     /**
       
    58      * Remove
       
    59      */
       
    60     _LIT( KRemove, "remove" );
       
    61     }
       
    62     
       
    63 
       
    64 /**
       
    65  * Configuration protocol cookie interface
       
    66  */
       
    67 class MNcdConfigurationProtocolCookie
       
    68     {        
       
    69 public:
       
    70 
       
    71     /**
       
    72      * Destructor
       
    73      */
       
    74     virtual ~MNcdConfigurationProtocolCookie() {}
       
    75 
       
    76     /**
       
    77      * Returns the key.
       
    78      * @return Keys string or KNullDesC
       
    79      */
       
    80     virtual const TDesC& Key() const = 0;
       
    81 
       
    82     /**
       
    83      * Returns the type.
       
    84      * @return Type string or KNullDesC
       
    85      */
       
    86     virtual const TDesC& Type() const = 0;
       
    87 
       
    88     /**
       
    89      * Returns the cookie scope.
       
    90      * @return Scope string or KNullDesC
       
    91      */
       
    92     virtual const TDesC& Scope() const = 0;
       
    93 
       
    94     /**
       
    95      * Returns the expiration delta.
       
    96      * @return Delta value in minutes
       
    97      */
       
    98     virtual TInt ExpirationDelta() const = 0;
       
    99 
       
   100     /**
       
   101      * Returns the amount of value fields.
       
   102      * @return Value count
       
   103      */
       
   104     virtual TInt ValueCount() const = 0;
       
   105 
       
   106     /**
       
   107      * Get a value.
       
   108      * @param aIndex Value index. 
       
   109      * @return Value string.
       
   110      * @see ValueCount()
       
   111      */
       
   112     virtual const TDesC& Value( TInt aIndex ) const = 0;
       
   113 
       
   114 
       
   115     /**
       
   116      * Sim identification getter 
       
   117      */
       
   118     virtual const TDesC8& Sim() const = 0;
       
   119     
       
   120     /**
       
   121      * Expiration time getter     
       
   122      */
       
   123     virtual TTime ExpirationTime() const = 0;
       
   124     };
       
   125 
       
   126 #endif