/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

* Declaration of SsmSystemCmdsFactory class.

*

*/

#ifndef SSMSYSTEMCMDSFACTORY_H

#define SSMSYSTEMCMDSFACTORY_H

#include <e32def.h>

class MSsmCustomCommand;

/**

 *  Creates custom command objects.

 *

 *  Custom commands are loaded by system state manager based on DLL name and

 *  function ordinal.

 *  Each DLL containing custom commands must offer factory methods for each

 *  custom command.

 *  The function ordinals must be exactly the same in emulator and HW builds

 *  or loading the custom command may have unpredictable results.

 *

 *  SsmSystemCmdsFactory is a static class containing factory method of one

 *  custom command. It can be easily extended to contain factory methods of

 *  multiple custom commands by adding more member functions.

 *

 *  It is better to implement own factory method for each separate command

 *  than to try to use command parameters to distinguis between them.

 *  Note that similar commands can be implemented in the same command class -

 *  just the factory methods need to be different.

 */

class SsmSystemCmdsFactory

    {

public:

    /**

     * Creates and returns a custom command of type CSsmsInitPsKeys.

     * This method has function ordinal 1 in ssmsystemcmds.dll.

     *

     * @return A custom command object.

     */

	IMPORT_C static MSsmCustomCommand* InitPsKeysNewL();

    /**

     *  Creates and returns a custom command of type CSsmInitStartupReason.

     * This method has function ordinal 2 in ssmsystemcmds.dll.

     *

     * @return A custom command object.

     */

    IMPORT_C static MSsmCustomCommand* InitStartupReasonNewL();

    /**

     * Creates and returns a custom command of type CSsmInitCriticalLevels.

     * This method has function ordinal 3 in ssmsystemcmds.dll.

     *

     * @return A custom command object.

     */

    IMPORT_C static MSsmCustomCommand* InitCriticalLevelsNewL();

    /**

     * Creates and returns a custom command of type CSsmWaitPsKey.

     * This method has function ordinal 5 in ssmsystemcmds.dll.

     *

     * @return A custom command object.

     */

    IMPORT_C static MSsmCustomCommand* WaitForPsKeyExactNewL();

    /**

     * Creates and returns a custom command of type CSsmWaitPsKey.

     * This method has function ordinal 6 in ssmsystemcmds.dll.

     *

     * @return A custom command object.

     */

    IMPORT_C static MSsmCustomCommand* WaitForPsKeyRangeNewL();

    /**

     * Creates and returns a custom command of type CSsmSaShutdown.

     * This method has function ordinal 7 in ssmsystemcmds.dll.

     *

     * @return A custom command object.

     */

    IMPORT_C static MSsmCustomCommand* SaShutdownNewL();

    };

#endif // SSMSYSTEMCMDSFACTORY