1 /*

     2 * Copyright (c) 2006-2007 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:  Action indication class declaration.

    15 *

    16 */

    17 

    18 

    19 #ifndef C_CFACTIONINDICATION_H

    20 #define C_CFACTIONINDICATION_H

    21 

    22 #include <e32base.h>

    23 #include <CFKeyValuePair.h>

    24 

    25 /**

    26 * Encapsulates inside an action indication. Action indication consists of

    27 * an action identifier and a set of paramters.

    28 * When an action indication is received the rule inside a script has

    29 * been evaluated to true. Action with identified by the action ID is

    30 * needed to be executed with the parameters assocaited with the action

    31 * indication.

    32 * 

    33 * @since S60 5.0

    34 * @lib cfservices.lib

    35 */

    36 NONSHARABLE_CLASS( CCFActionIndication ): public CBase

    37     {

    38     public:

    39 

    40         // Two phased constructors

    41         IMPORT_C static CCFActionIndication* NewL();

    42         IMPORT_C static CCFActionIndication* NewLC();

    43 

    44     public: // New methods

    45     

    46         /**

    47         * Sets identifier for the action.

    48         * 

    49         * @since S60 5.0

    50         * @param aIdentifier New identifier.

    51         * @return None

    52         */

    53         virtual void SetIdentifierL( const TDesC& aIdentifier ) = 0;

    54         

    55         /**

    56         * Returns action identifier associated with the indication.

    57         * 

    58         * @since S60 5.0

    59         * @param None

    60         * @return const TDesC&

    61         */

    62         virtual const TDesC& Identifier() const = 0;

    63         

    64         /**

    65         * Adds new key value pair parameter.

    66         * 

    67         * @since S60 5.0

    68         * @param aKey Name of the key.

    69         * @param aValue Value for the key.

    70         * @return None

    71         */

    72         virtual void AddParameterL( const TDesC& aKey, const TDesC& aValue ) = 0;

    73 

    74         /**

    75         * Returns parameters related to the action in a key

    76         * value pair array.

    77         * 

    78         * @since S60 5.0

    79         * @param None

    80         * @return const RKeyValueArray&

    81         */

    82         virtual const RKeyValueArray& Parameters() const = 0;

    83     };

    84 

    85 #endif