1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/featuremgmt/featuremgr/src/clientdll/featureclient.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,177 @@
1.4 +/*
1.5 +* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +
1.24 +#ifndef FEATURECLIENT_H
1.25 +#define FEATURECLIENT_H
1.26 +
1.27 +// INCLUDES
1.28 +#include <e32base.h>
1.29 +#include <featmgr/featurecmn.h>
1.30 +
1.31 +// CLASS DECLARATION
1.32 +
1.33 +/**
1.34 +* Feature manager client interface.
1.35 +*
1.36 +*/
1.37 +class MFeatureClient
1.38 + {
1.39 + public: // From MFeatureClient
1.40 +
1.41 + /**
1.42 + * Checks if specified feature is supported and returns
1.43 + * its flags and data if requested.
1.44 + * @param aFeature feature entry
1.45 + * @return Positive (1) if the feature is supported,
1.46 + * Zero if feature is not supported.
1.47 + * KErrNotFound if feature not found.
1.48 + * Otherwise one of the Symbian error codes.
1.49 + */
1.50 + virtual TInt FeatureSupported( TFeatureEntry& aFeature ) const = 0;
1.51 +
1.52 + /**
1.53 + * Fills feature status array according to status/data in server
1.54 + *
1.55 + * @param aFeatures feature entry array
1.56 + * @return KErrNone if no error fetching feature statuses.
1.57 + * Otherwise one of the Symbian OS error codes.
1.58 + */
1.59 + virtual TInt FeaturesSupported( RFeatureArray& aFeatures ) = 0;
1.60 +
1.61 + /**
1.62 + * Enables a certain feature.
1.63 + *
1.64 + * @param aFeature Feature ID.
1.65 + * @return KErrNone if the feature was succesfully enabled.
1.66 + * KErrAccessDenied if the feature is not modifiable.
1.67 + * KErrPermissionDenied if a capability check fails.
1.68 + * Otherwise one of the Symbian error codes.
1.69 + */
1.70 + virtual TInt EnableFeature( TUid aFeature ) const = 0;
1.71 +
1.72 + /**
1.73 + * Disable a certain feature.
1.74 + *
1.75 + * @param aFeature Feature ID.
1.76 + * @return KErrNone if the feature was succesfully disabled.
1.77 + * KErrAccessDenied if the feature is not modifiable.
1.78 + * KErrPermissionDenied if a capability check fails.
1.79 + * Otherwise one of the Symbian error codes.
1.80 + */
1.81 + virtual TInt DisableFeature( TUid aFeature ) const = 0;
1.82 +
1.83 + /**
1.84 + * Enables or disables a certain feature and sets feature data.
1.85 + *
1.86 + * @param aFeature Feature ID.
1.87 + * @param aEnabled Feature enable or disable.
1.88 + * @param aData Feature data.
1.89 + * @return KErrNone if the feature was succesfully enabled.
1.90 + * KErrAccessDenied if the feature is not modifiable.
1.91 + * KErrPermissionDenied if a capability check fails.
1.92 + * Otherwise one of the Symbian error codes.
1.93 + */
1.94 + virtual TInt SetFeature( TUid aFeature, TBool aEnabled, TInt aData ) const = 0;
1.95 +
1.96 + /**
1.97 + * Sets certain feature's data.
1.98 + *
1.99 + * @param aFeature Feature ID.
1.100 + * @param aData Feature data.
1.101 + * @return KErrNone if feature data was succesfully set.
1.102 + * KErrAccessDenied if the feature is not modifiable.
1.103 + * KErrPermissionDenied if a capability check fails.
1.104 + * Otherwise one of the Symbian error codes.
1.105 + */
1.106 + virtual TInt SetFeature( TUid aFeature, TInt aData ) const = 0;
1.107 +
1.108 + /**
1.109 + * Add a new feature.
1.110 + *
1.111 + * @param aFeature Feature entry.
1.112 + * @return KErrNone if the feature was succesfully added.
1.113 + * KErrAccessDenied if the feature is not modifiable.
1.114 + * KErrPermissionDenied if a capability check fails.
1.115 + * KErrAlreadyExists if feature already exists.
1.116 + * Otherwise one of the Symbian error codes.
1.117 + */
1.118 + virtual TInt AddFeature( TFeatureEntry aEntry ) const = 0;
1.119 +
1.120 + /**
1.121 + * Delete a feature.
1.122 + *
1.123 + * @param aFeature Feature ID.
1.124 + * @return KErrNone if the feature was successfully deleted.
1.125 + * KErrAccessDenied if the feature is not added using AddFeature() method.
1.126 + * KErrPermissionDenied if a capability check fails.
1.127 + * KErrNotFound if the feature not found.
1.128 + * Otherwise one of the Symbian error codes.
1.129 + */
1.130 + virtual TInt DeleteFeature( TUid aFeature ) const = 0;
1.131 +
1.132 + /**
1.133 + * Lists all supported features.
1.134 + *
1.135 + * @param aSupportedFeatures A reference to a client owned RFeatureUidArray
1.136 + * array which will be filled with the IDs of supported features.
1.137 + * @return - One of the Symbian error codes.
1.138 + */
1.139 + virtual void ListSupportedFeaturesL( RFeatureUidArray& aSupportedFeatures ) = 0;
1.140 +
1.141 + /**
1.142 + * Requests notification for subset of features changes.
1.143 + *
1.144 + * @param aFeatures Features, from which client requests notification.
1.145 + * @param aFeatUid Feature id, which will be set by server on completion.
1.146 + * @param aStatus Client request to be signaled.
1.147 + * @return - One of the Symbian error codes.
1.148 + */
1.149 + virtual TInt RequestNotification( RFeatureUidArray& aFeatures, TUid& aFeatUid,
1.150 + TRequestStatus& aStatus ) = 0;
1.151 +
1.152 + /**
1.153 + * Re-requests notification of a feature change.
1.154 + *
1.155 + * @param aFeatUid UId of the feature to be re-requested.
1.156 + * @param aStatus Client request to be signalled asynchronously.
1.157 + * @return One of the Symbian OS system-wide error codes.
1.158 + */
1.159 + virtual void ReRequestNotification( TUid& aFeatUid, TRequestStatus& aStatus ) = 0;
1.160 +
1.161 + /**
1.162 + * Cancel notification request for single feature's changes.
1.163 + *
1.164 + * @param aFeature Feature, for which client notification cancellation.
1.165 + * @return - One of the Symbian error codes.
1.166 + */
1.167 + virtual TInt RequestNotifyCancel( TUid aFeature ) const = 0;
1.168 +
1.169 + /**
1.170 + * Cancel notification request for all features changes.
1.171 + *
1.172 + * @return - One of the Symbian error codes.
1.173 + */
1.174 + virtual TInt RequestNotifyCancelAll( ) const = 0;
1.175 +
1.176 + };
1.177 +
1.178 +#endif // FEATURECLIENT_H
1.179 +
1.180 +// End of File