contextframework/cfw/inc/cfserver/cfcmd.h
changeset 0 2e3d3ce01487
equal deleted inserted replaced
-1:000000000000 0:2e3d3ce01487
       
     1 /*
       
     2 * Copyright (c) 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:  CCFCmd class declaration.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CFCMD_H
       
    20 #define C_CFCMD_H
       
    21 
       
    22 
       
    23 // SYSTEM INCLUDE FILES
       
    24 #include <e32base.h>
       
    25 
       
    26 // USER INCLUDE FILES
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 class MCFContextSubscriptionListener;
       
    30 
       
    31 // DATA TYPES
       
    32 
       
    33 // CLASS DECLARATION
       
    34 
       
    35 /**
       
    36  * Abstract base class for commands.
       
    37  *
       
    38  * @lib CFServer
       
    39  * @since S60 5.0
       
    40  */
       
    41 NONSHARABLE_CLASS( CCFCmd ) : public CBase
       
    42     {
       
    43 public:
       
    44 
       
    45     /**
       
    46      * C++ destructor.
       
    47      */
       
    48     virtual ~CCFCmd( );
       
    49 
       
    50 public:
       
    51 
       
    52     /**
       
    53      * Executes the command.
       
    54      *
       
    55      * @since S60 5.0
       
    56      * @param None.
       
    57      * @return None.
       
    58      */
       
    59     virtual void ExecuteL() = 0;
       
    60 
       
    61     /**
       
    62      * Logs the error using error trace macros.
       
    63      *
       
    64      * @since S60 5.0
       
    65      * @param aError is the leave code from a call to ExecuteL.
       
    66      * @return None.
       
    67      */
       
    68     virtual void LogError( TInt aError );
       
    69 
       
    70     /**
       
    71      * Returns the singly linked list's link offset.
       
    72      *
       
    73      * @since S60 5.0
       
    74      * @param None.
       
    75      * @return Singly linked list's link offset.
       
    76      */
       
    77     static TInt SglQueLinkOffset();
       
    78 
       
    79 protected:
       
    80 
       
    81     CCFCmd();
       
    82 
       
    83 private: // Data
       
    84 
       
    85     // Singly linked list link object.
       
    86     TSglQueLink iSlink;
       
    87     };
       
    88 
       
    89 #endif // C_CFCMD_H