diff -r 000000000000 -r e4d67989cc36 lowlevellibsandfws/pluginfw/Framework/FrameTests/MagicTransitionValidation.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/lowlevellibsandfws/pluginfw/Framework/FrameTests/MagicTransitionValidation.h Tue Feb 02 02:01:42 2010 +0200 @@ -0,0 +1,236 @@ +// Copyright (c) 1997-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: +// Definitions for the transition validation classes for ECom +// +// + +#ifndef __EXAMPLEINTERFACETRANSITIONVALIDATION_H__ +#define __EXAMPLEINTERFACETRANSITIONVALIDATION_H__ + +#include "MagicTransitions.h" + + +// ______________________________________________________________________________ +// +/** + @internalComponent + Comments : Provide all the CtorUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CExampleInterface test class for a transition. + */ +class TExampleInterface_Ctor_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TExampleInterface_Ctor_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : Default constructor + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TExampleInterface_Ctor_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TExampleInterface_Ctor_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TExampleInterface_Ctor_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TExampleInterface_Ctor_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + Comments : Provide all the DtorUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CExampleInterface test class for a transition. + */ +class TExampleInterface_Dtor_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TExampleInterface_Dtor_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : Default constructor + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TExampleInterface_Dtor_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TExampleInterface_Dtor_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TExampleInterface_Dtor_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TExampleInterface_Dtor_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + Comments : Provide all the ListImplementationsUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CExampleInterface test class for a transition. + */ +class TExampleInterface_ListImplementations_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TExampleInterface_ListImplementations_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TExampleInterface_ListImplementations_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TExampleInterface_ListImplementations_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TExampleInterface_ListImplementations_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TExampleInterface_ListImplementations_TransitionValidator + +// ______________________________________________________________________________ +// +/** + @internalComponent + Comments : Provide all the ListImplementationsUnit Test's specific + validatation for the state of a transition before and after its execution. + on the CExampleInterface test class for a transition. + + */ +class TExampleInterface_Default_TransitionValidator : public TTransitionValidator + { +public: + /** + @fn TExampleInterface_Default_TransitionValidator(CUnitTestContext& aUTContext) + Intended Usage : + @leave KErrNoMemory + @since 7.0 + @param aUTContext The context within which this transition is executing + */ + inline TExampleInterface_Default_TransitionValidator(CUnitTestContext& aUTContext); + + /** + @fn ValidatePreConditions() + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + Error Condition : Invalid pre-conditions + @since 7.0 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise. + @pre TExampleInterface_Default_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePreConditions(); + + /** + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState) + Intended Usage : Implemented by the developer to check the + end state of the transition behaviour. + When overriding, if the transition calls an asynchronous function + ValidatePostConditions will be called twice. Firstly, after the + asynchronous function has been called and, secondly, after the + asynchronous request has completed. The parameter aAsyncState can + be used to distinguish between these two cases. + Error Condition : Invalid post-conditions. + @since 7.0 + @param aAsyncState EAsyncCalled if the async function has been just been called, + EAsyncCompleted if the function has completed. + @return TBool ETrue if the post-conditions were valid, EFalse otherwise. + @pre TExampleInterface_Default_TransitionValidator is fully constructed. + @post No change to the iUTContext class. + */ + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState); + }; // TExampleInterface_Default_TransitionValidator + + +#include "MagicTransitionValidation.inl" + +#endif // __EXAMPLEINTERFACETRANSITIONVALIDATION_H__