os/ossrv/lowlevellibsandfws/pluginfw/Framework/FrameTests/MagicTransitionValidation.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/FrameTests/MagicTransitionValidation.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,236 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Definitions for the transition validation classes for ECom
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __EXAMPLEINTERFACETRANSITIONVALIDATION_H__
1.22 +#define __EXAMPLEINTERFACETRANSITIONVALIDATION_H__
1.23 +
1.24 +#include "MagicTransitions.h"
1.25 +
1.26 +
1.27 +// ______________________________________________________________________________
1.28 +//
1.29 +/**
1.30 + @internalComponent
1.31 + Comments : Provide all the CtorUnit Test's specific
1.32 + validatation for the state of a transition before and after its execution.
1.33 + on the CExampleInterface test class for a transition.
1.34 + */
1.35 +class TExampleInterface_Ctor_TransitionValidator : public TTransitionValidator
1.36 + {
1.37 +public:
1.38 + /**
1.39 + @fn TExampleInterface_Ctor_TransitionValidator(CUnitTestContext& aUTContext)
1.40 + Intended Usage : Default constructor
1.41 + @leave KErrNoMemory
1.42 + @since 7.0
1.43 + @param aUTContext The context within which this transition is executing
1.44 + */
1.45 + inline TExampleInterface_Ctor_TransitionValidator(CUnitTestContext& aUTContext);
1.46 +
1.47 + /**
1.48 + @fn ValidatePreConditions()
1.49 + Intended Usage : Implemented by the developer to check the
1.50 + end state of the transition behaviour.
1.51 + Error Condition : Invalid pre-conditions
1.52 + @since 7.0
1.53 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise.
1.54 + @pre TExampleInterface_Ctor_TransitionValidator is fully constructed.
1.55 + @post No change to the iUTContext class.
1.56 + */
1.57 + virtual inline TBool ValidatePreConditions();
1.58 +
1.59 + /**
1.60 + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState)
1.61 + Intended Usage : Implemented by the developer to check the
1.62 + end state of the transition behaviour.
1.63 + When overriding, if the transition calls an asynchronous function
1.64 + ValidatePostConditions will be called twice. Firstly, after the
1.65 + asynchronous function has been called and, secondly, after the
1.66 + asynchronous request has completed. The parameter aAsyncState can
1.67 + be used to distinguish between these two cases.
1.68 + Error Condition : Invalid post-conditions.
1.69 + @since 7.0
1.70 + @param aAsyncState EAsyncCalled if the async function has been just been called,
1.71 + EAsyncCompleted if the function has completed.
1.72 + @return TBool ETrue if the post-conditions were valid, EFalse otherwise.
1.73 + @pre TExampleInterface_Ctor_TransitionValidator is fully constructed.
1.74 + @post No change to the iUTContext class.
1.75 + */
1.76 + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState);
1.77 + }; // TExampleInterface_Ctor_TransitionValidator
1.78 +
1.79 +// ______________________________________________________________________________
1.80 +//
1.81 +/**
1.82 + @internalComponent
1.83 + Comments : Provide all the DtorUnit Test's specific
1.84 + validatation for the state of a transition before and after its execution.
1.85 + on the CExampleInterface test class for a transition.
1.86 + */
1.87 +class TExampleInterface_Dtor_TransitionValidator : public TTransitionValidator
1.88 + {
1.89 +public:
1.90 + /**
1.91 + @fn TExampleInterface_Dtor_TransitionValidator(CUnitTestContext& aUTContext)
1.92 + Intended Usage : Default constructor
1.93 + @leave KErrNoMemory
1.94 + @since 7.0
1.95 + @param aUTContext The context within which this transition is executing
1.96 + */
1.97 + inline TExampleInterface_Dtor_TransitionValidator(CUnitTestContext& aUTContext);
1.98 +
1.99 + /**
1.100 + @fn ValidatePreConditions()
1.101 + Intended Usage : Implemented by the developer to check the
1.102 + end state of the transition behaviour.
1.103 + Error Condition : Invalid pre-conditions
1.104 + @since 7.0
1.105 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise.
1.106 + @pre TExampleInterface_Dtor_TransitionValidator is fully constructed.
1.107 + @post No change to the iUTContext class.
1.108 + */
1.109 + virtual inline TBool ValidatePreConditions();
1.110 +
1.111 + /**
1.112 + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState)
1.113 + Intended Usage : Implemented by the developer to check the
1.114 + end state of the transition behaviour.
1.115 + When overriding, if the transition calls an asynchronous function
1.116 + ValidatePostConditions will be called twice. Firstly, after the
1.117 + asynchronous function has been called and, secondly, after the
1.118 + asynchronous request has completed. The parameter aAsyncState can
1.119 + be used to distinguish between these two cases.
1.120 + Error Condition : Invalid post-conditions.
1.121 + @since 7.0
1.122 + @param aAsyncState EAsyncCalled if the async function has been just been called,
1.123 + EAsyncCompleted if the function has completed.
1.124 + @return TBool ETrue if the post-conditions were valid, EFalse otherwise.
1.125 + @pre TExampleInterface_Dtor_TransitionValidator is fully constructed.
1.126 + @post No change to the iUTContext class.
1.127 + */
1.128 + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState);
1.129 + }; // TExampleInterface_Dtor_TransitionValidator
1.130 +
1.131 +// ______________________________________________________________________________
1.132 +//
1.133 +/**
1.134 + @internalComponent
1.135 + Comments : Provide all the ListImplementationsUnit Test's specific
1.136 + validatation for the state of a transition before and after its execution.
1.137 + on the CExampleInterface test class for a transition.
1.138 + */
1.139 +class TExampleInterface_ListImplementations_TransitionValidator : public TTransitionValidator
1.140 + {
1.141 +public:
1.142 + /**
1.143 + @fn TExampleInterface_ListImplementations_TransitionValidator(CUnitTestContext& aUTContext)
1.144 + Intended Usage :
1.145 + @leave KErrNoMemory
1.146 + @since 7.0
1.147 + @param aUTContext The context within which this transition is executing
1.148 + */
1.149 + inline TExampleInterface_ListImplementations_TransitionValidator(CUnitTestContext& aUTContext);
1.150 +
1.151 + /**
1.152 + @fn ValidatePreConditions()
1.153 + Intended Usage : Implemented by the developer to check the
1.154 + end state of the transition behaviour.
1.155 + Error Condition : Invalid pre-conditions
1.156 + @since 7.0
1.157 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise.
1.158 + @pre TExampleInterface_ListImplementations_TransitionValidator is fully constructed.
1.159 + @post No change to the iUTContext class.
1.160 + */
1.161 + virtual inline TBool ValidatePreConditions();
1.162 +
1.163 + /**
1.164 + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState)
1.165 + Intended Usage : Implemented by the developer to check the
1.166 + end state of the transition behaviour.
1.167 + When overriding, if the transition calls an asynchronous function
1.168 + ValidatePostConditions will be called twice. Firstly, after the
1.169 + asynchronous function has been called and, secondly, after the
1.170 + asynchronous request has completed. The parameter aAsyncState can
1.171 + be used to distinguish between these two cases.
1.172 + Error Condition : Invalid post-conditions.
1.173 + @since 7.0
1.174 + @param aAsyncState EAsyncCalled if the async function has been just been called,
1.175 + EAsyncCompleted if the function has completed.
1.176 + @return TBool ETrue if the post-conditions were valid, EFalse otherwise.
1.177 + @pre TExampleInterface_ListImplementations_TransitionValidator is fully constructed.
1.178 + @post No change to the iUTContext class.
1.179 + */
1.180 + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState);
1.181 + }; // TExampleInterface_ListImplementations_TransitionValidator
1.182 +
1.183 +// ______________________________________________________________________________
1.184 +//
1.185 +/**
1.186 + @internalComponent
1.187 + Comments : Provide all the ListImplementationsUnit Test's specific
1.188 + validatation for the state of a transition before and after its execution.
1.189 + on the CExampleInterface test class for a transition.
1.190 +
1.191 + */
1.192 +class TExampleInterface_Default_TransitionValidator : public TTransitionValidator
1.193 + {
1.194 +public:
1.195 + /**
1.196 + @fn TExampleInterface_Default_TransitionValidator(CUnitTestContext& aUTContext)
1.197 + Intended Usage :
1.198 + @leave KErrNoMemory
1.199 + @since 7.0
1.200 + @param aUTContext The context within which this transition is executing
1.201 + */
1.202 + inline TExampleInterface_Default_TransitionValidator(CUnitTestContext& aUTContext);
1.203 +
1.204 + /**
1.205 + @fn ValidatePreConditions()
1.206 + Intended Usage : Implemented by the developer to check the
1.207 + end state of the transition behaviour.
1.208 + Error Condition : Invalid pre-conditions
1.209 + @since 7.0
1.210 + @return TBool ETrue if the pre-conditions were valid, EFalse otherwise.
1.211 + @pre TExampleInterface_Default_TransitionValidator is fully constructed.
1.212 + @post No change to the iUTContext class.
1.213 + */
1.214 + virtual inline TBool ValidatePreConditions();
1.215 +
1.216 + /**
1.217 + @fn ValidatePostConditions(TTestBedAsyncState aAsyncState)
1.218 + Intended Usage : Implemented by the developer to check the
1.219 + end state of the transition behaviour.
1.220 + When overriding, if the transition calls an asynchronous function
1.221 + ValidatePostConditions will be called twice. Firstly, after the
1.222 + asynchronous function has been called and, secondly, after the
1.223 + asynchronous request has completed. The parameter aAsyncState can
1.224 + be used to distinguish between these two cases.
1.225 + Error Condition : Invalid post-conditions.
1.226 + @since 7.0
1.227 + @param aAsyncState EAsyncCalled if the async function has been just been called,
1.228 + EAsyncCompleted if the function has completed.
1.229 + @return TBool ETrue if the post-conditions were valid, EFalse otherwise.
1.230 + @pre TExampleInterface_Default_TransitionValidator is fully constructed.
1.231 + @post No change to the iUTContext class.
1.232 + */
1.233 + virtual inline TBool ValidatePostConditions(TTestBedAsyncState aAsyncState);
1.234 + }; // TExampleInterface_Default_TransitionValidator
1.235 +
1.236 +
1.237 +#include "MagicTransitionValidation.inl"
1.238 +
1.239 +#endif // __EXAMPLEINTERFACETRANSITIONVALIDATION_H__