sl@0: /* sl@0: * Copyright (c) 2007-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: * sl@0: */ sl@0: sl@0: sl@0: sl@0: sl@0: #ifndef FEATURECLIENT_H sl@0: #define FEATURECLIENT_H sl@0: sl@0: // INCLUDES sl@0: #include sl@0: #include sl@0: sl@0: // CLASS DECLARATION sl@0: sl@0: /** sl@0: * Feature manager client interface. sl@0: * sl@0: */ sl@0: class MFeatureClient sl@0: { sl@0: public: // From MFeatureClient sl@0: sl@0: /** sl@0: * Checks if specified feature is supported and returns sl@0: * its flags and data if requested. sl@0: * @param aFeature feature entry sl@0: * @return Positive (1) if the feature is supported, sl@0: * Zero if feature is not supported. sl@0: * KErrNotFound if feature not found. sl@0: * Otherwise one of the Symbian error codes. sl@0: */ sl@0: virtual TInt FeatureSupported( TFeatureEntry& aFeature ) const = 0; sl@0: sl@0: /** sl@0: * Fills feature status array according to status/data in server sl@0: * sl@0: * @param aFeatures feature entry array sl@0: * @return KErrNone if no error fetching feature statuses. sl@0: * Otherwise one of the Symbian OS error codes. sl@0: */ sl@0: virtual TInt FeaturesSupported( RFeatureArray& aFeatures ) = 0; sl@0: sl@0: /** sl@0: * Enables a certain feature. sl@0: * sl@0: * @param aFeature Feature ID. sl@0: * @return KErrNone if the feature was succesfully enabled. sl@0: * KErrAccessDenied if the feature is not modifiable. sl@0: * KErrPermissionDenied if a capability check fails. sl@0: * Otherwise one of the Symbian error codes. sl@0: */ sl@0: virtual TInt EnableFeature( TUid aFeature ) const = 0; sl@0: sl@0: /** sl@0: * Disable a certain feature. sl@0: * sl@0: * @param aFeature Feature ID. sl@0: * @return KErrNone if the feature was succesfully disabled. sl@0: * KErrAccessDenied if the feature is not modifiable. sl@0: * KErrPermissionDenied if a capability check fails. sl@0: * Otherwise one of the Symbian error codes. sl@0: */ sl@0: virtual TInt DisableFeature( TUid aFeature ) const = 0; sl@0: sl@0: /** sl@0: * Enables or disables a certain feature and sets feature data. sl@0: * sl@0: * @param aFeature Feature ID. sl@0: * @param aEnabled Feature enable or disable. sl@0: * @param aData Feature data. sl@0: * @return KErrNone if the feature was succesfully enabled. sl@0: * KErrAccessDenied if the feature is not modifiable. sl@0: * KErrPermissionDenied if a capability check fails. sl@0: * Otherwise one of the Symbian error codes. sl@0: */ sl@0: virtual TInt SetFeature( TUid aFeature, TBool aEnabled, TInt aData ) const = 0; sl@0: sl@0: /** sl@0: * Sets certain feature's data. sl@0: * sl@0: * @param aFeature Feature ID. sl@0: * @param aData Feature data. sl@0: * @return KErrNone if feature data was succesfully set. sl@0: * KErrAccessDenied if the feature is not modifiable. sl@0: * KErrPermissionDenied if a capability check fails. sl@0: * Otherwise one of the Symbian error codes. sl@0: */ sl@0: virtual TInt SetFeature( TUid aFeature, TInt aData ) const = 0; sl@0: sl@0: /** sl@0: * Add a new feature. sl@0: * sl@0: * @param aFeature Feature entry. sl@0: * @return KErrNone if the feature was succesfully added. sl@0: * KErrAccessDenied if the feature is not modifiable. sl@0: * KErrPermissionDenied if a capability check fails. sl@0: * KErrAlreadyExists if feature already exists. sl@0: * Otherwise one of the Symbian error codes. sl@0: */ sl@0: virtual TInt AddFeature( TFeatureEntry aEntry ) const = 0; sl@0: sl@0: /** sl@0: * Delete a feature. sl@0: * sl@0: * @param aFeature Feature ID. sl@0: * @return KErrNone if the feature was successfully deleted. sl@0: * KErrAccessDenied if the feature is not added using AddFeature() method. sl@0: * KErrPermissionDenied if a capability check fails. sl@0: * KErrNotFound if the feature not found. sl@0: * Otherwise one of the Symbian error codes. sl@0: */ sl@0: virtual TInt DeleteFeature( TUid aFeature ) const = 0; sl@0: sl@0: /** sl@0: * Lists all supported features. sl@0: * sl@0: * @param aSupportedFeatures A reference to a client owned RFeatureUidArray sl@0: * array which will be filled with the IDs of supported features. sl@0: * @return - One of the Symbian error codes. sl@0: */ sl@0: virtual void ListSupportedFeaturesL( RFeatureUidArray& aSupportedFeatures ) = 0; sl@0: sl@0: /** sl@0: * Requests notification for subset of features changes. sl@0: * sl@0: * @param aFeatures Features, from which client requests notification. sl@0: * @param aFeatUid Feature id, which will be set by server on completion. sl@0: * @param aStatus Client request to be signaled. sl@0: * @return - One of the Symbian error codes. sl@0: */ sl@0: virtual TInt RequestNotification( RFeatureUidArray& aFeatures, TUid& aFeatUid, sl@0: TRequestStatus& aStatus ) = 0; sl@0: sl@0: /** sl@0: * Re-requests notification of a feature change. sl@0: * sl@0: * @param aFeatUid UId of the feature to be re-requested. sl@0: * @param aStatus Client request to be signalled asynchronously. sl@0: * @return One of the Symbian OS system-wide error codes. sl@0: */ sl@0: virtual void ReRequestNotification( TUid& aFeatUid, TRequestStatus& aStatus ) = 0; sl@0: sl@0: /** sl@0: * Cancel notification request for single feature's changes. sl@0: * sl@0: * @param aFeature Feature, for which client notification cancellation. sl@0: * @return - One of the Symbian error codes. sl@0: */ sl@0: virtual TInt RequestNotifyCancel( TUid aFeature ) const = 0; sl@0: sl@0: /** sl@0: * Cancel notification request for all features changes. sl@0: * sl@0: * @return - One of the Symbian error codes. sl@0: */ sl@0: virtual TInt RequestNotifyCancelAll( ) const = 0; sl@0: sl@0: }; sl@0: sl@0: #endif // FEATURECLIENT_H sl@0: sl@0: // End of File