sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // This file contains the definition of the class MStateAccessor
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @test
sl@0: */
sl@0: 
sl@0: #ifndef __STATEACCESSOR_H__
sl@0: #define __STATEACCESSOR_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: 
sl@0: /**
sl@0: 	@internalAll	
sl@0: 	Comments : Mixin which is used to define a class used for state checking of 
sl@0: 	a test object.
sl@0:  */
sl@0: 
sl@0: class MStateAccessor
sl@0: 	{
sl@0: public:
sl@0: /**
sl@0: 	@fn				InvariantTest(TAny* aTestObject) = 0
sl@0: 	Intended Usage	:	Override this in the derived class to implement 
sl@0: 						invariant testing
sl@0: 	@since			7.0
sl@0: 	@param			aTestObject The object to be tested
sl@0: 	@return			One of the EPOC standard error codes indicating the result of the test
sl@0: 	@pre 			A valid test object must be passed in
sl@0: 	@post			Returns an error code dependant on the result of the test
sl@0:  */
sl@0: 	
sl@0: 	virtual TInt InvariantTest(TAny* aTestObject) = 0;
sl@0: /**
sl@0: 	@fn				Internalize(TAny* aTestObject) = 0
sl@0: 	Intended Usage	:	Override this in the derived class to implement 
sl@0: 						object state loading.
sl@0: 	@since			7.0
sl@0: 	@param			aTestObject The object to be tested
sl@0: 	@return			One of the EPOC standard error codes indicating the outcome of the attempt
sl@0: 	to load the object state.
sl@0: 	@pre 			A valid test object must be passed in
sl@0: 	@post			Returns an error code dependant on the result of the test
sl@0:  */
sl@0: 	
sl@0: 	virtual TInt Internalize(TAny* aTestObject) = 0;
sl@0: /**
sl@0: 	@fn				Externalize(TAny* aTestObject) = 0
sl@0: 	Intended Usage	:	Override this in the derived class to implement 
sl@0: 						object state persistence.
sl@0: 	@since			7.0
sl@0: 	@param			aTestObject The object to be tested
sl@0: 	@return			One of the EPOC standard error codes indicating the outcome of attempt
sl@0: 	to externalize the object.
sl@0: 	@pre 			A valid test object must be passed in
sl@0: 	@post			Returns an error code dependant on the result of the test
sl@0:  */
sl@0: 	
sl@0: 	virtual TInt Externalize(TAny* aTestObject) = 0;
sl@0: 	};
sl@0: 
sl@0: #endif