1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // This file contains the definition of the class MStateAccessor
22 #ifndef __STATEACCESSOR_H__
23 #define __STATEACCESSOR_H__
29 Comments : Mixin which is used to define a class used for state checking of
37 @fn InvariantTest(TAny* aTestObject) = 0
38 Intended Usage : Override this in the derived class to implement
41 @param aTestObject The object to be tested
42 @return One of the EPOC standard error codes indicating the result of the test
43 @pre A valid test object must be passed in
44 @post Returns an error code dependant on the result of the test
47 virtual TInt InvariantTest(TAny* aTestObject) = 0;
49 @fn Internalize(TAny* aTestObject) = 0
50 Intended Usage : Override this in the derived class to implement
53 @param aTestObject The object to be tested
54 @return One of the EPOC standard error codes indicating the outcome of the attempt
55 to load the object state.
56 @pre A valid test object must be passed in
57 @post Returns an error code dependant on the result of the test
60 virtual TInt Internalize(TAny* aTestObject) = 0;
62 @fn Externalize(TAny* aTestObject) = 0
63 Intended Usage : Override this in the derived class to implement
64 object state persistence.
66 @param aTestObject The object to be tested
67 @return One of the EPOC standard error codes indicating the outcome of attempt
68 to externalize the object.
69 @pre A valid test object must be passed in
70 @post Returns an error code dependant on the result of the test
73 virtual TInt Externalize(TAny* aTestObject) = 0;