contextframework/cfw/inc/cfserver/cfactionhandler.h
changeset 0 2e3d3ce01487
equal deleted inserted replaced
-1:000000000000 0:2e3d3ce01487
       
     1 /*
       
     2 * Copyright (c) 2002-2008 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:  MCFActionHandler interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef M_CFACTIONHANDLER_H
       
    21 #define M_CFACTIONHANDLER_H
       
    22 
       
    23 // FORWARD DECLARATIONS
       
    24 class CCFScriptEvent;
       
    25 class CCFContextSourceCommand;
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30 * M interface class for notifying action handler provider about an action event
       
    31 * and getting a security policy of the action.
       
    32 *
       
    33 *  @lib CFServer
       
    34 *  @since Series 60 2.6
       
    35 */
       
    36 class MCFActionHandler
       
    37     {
       
    38 public:
       
    39 
       
    40     /**
       
    41     * Notifies action handler provider about the occurred action event.
       
    42     *
       
    43     * @param aEvent is a pointer to CCFScriptEvent that contains action (script
       
    44     *   event) information. Ownership is transferred.
       
    45     * @return None.
       
    46     */
       
    47     virtual void FireActionL( CCFScriptEvent* aEvent ) = 0;
       
    48 
       
    49     /**
       
    50     * Notifies action handler provider about the occurred context source command
       
    51     * action.
       
    52     *
       
    53     * @param aCommand is the context source command.
       
    54     * @return None.
       
    55     */
       
    56     virtual void FireActionL( const CCFContextSourceCommand& aCommand ) = 0;
       
    57 
       
    58 	/**
       
    59 	* Gets the security policy of a particular action.
       
    60 	*
       
    61 	* @param aActionIdentifier is the identifier of the action.
       
    62 	* @param aPolicy is the security policy which will be set by this method.
       
    63 	* @return KErrNone if action was found, KErrNotFound if not.
       
    64 	*/
       
    65 	virtual TInt GetActionSecurityPolicy( const TDesC& aActionIdentifier,
       
    66 		TSecurityPolicy& aPolicy ) = 0;
       
    67 
       
    68     };
       
    69 
       
    70 #endif // M_CFACTIONHANDLER_H