epoc32/include/mw/msenservicepolicy.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h) This is the epoc32/include tree with the "platform" subtrees removed, and all but a selected few mbg and rsg files removed.

/*
* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: Service policy interface for serene   
*
*/

#ifndef M_SEN_SERVICE_POLICY_H
#define M_SEN_SERVICE_POLICY_H

//  INCLUDES
#include <e32base.h> // for CActive
#include <badesca.h>

#include "SenDomFragment.h"

typedef RPointerArray<CSenElement> RPolicyArray;

// FORWARD DECLARATION

// CLASS DECLARATION
/*
*   <ServicePolicy>
*       <ClientPolicy>
*			<MetadataEndpoint>uri.1</MetadataEndpoint>
*			<MetadataEndpoint>uri.2</MetadataEndpoint>
*			<MetadataEndpoint>uri.3</MetadataEndpoint>
*           <PolicyValue1/>				
*           <PolicyValue2/>				
*       </ClientPolicy>
*       <PolicyArrray>
*			<wsp:Policy1/>
*			<wsp:Policy2/>
*       </PolicyArrray>
*   </ServicePolicy>
*/
class MSenServicePolicy
    {
    public: // New functions

        /**
        * Adds a policy in SD
        * Method is used to add a RAW policy obtained 
        * by Network or some dynamic means
        * @since Series60 4.0
        * @param aPolicy is the Policy Element
        */ 
        virtual TInt AddPolicyL(CSenElement* aPolicy) = 0;

        /**
        * Remove  a Policy from SD
        * @param aPolicyName , Policy with this name will be removed from SD
        * @return
        *  - KErrNone 
        
        */ 
        virtual TInt RemovePolicyL(TDesC8& aPolicyName) = 0;

        /**
        * Method reads provider policy class instance values from given
        * template. 
        * @since Series60 4.0
        * @param aTemplate from which the values are read.
        * @return   
        *           
        */ 
        virtual TInt RebuildServicePolicyFrom(MSenServicePolicy& aTemplate) = 0;
        
        /**
        * Checks if policies match.
        * @return ETrue if policies match, EFalse if not.
        */
        virtual TBool Accepts(MSenServicePolicy& aPolicyPattern) = 0;
       
        /**
        * Getter for ServicePolicies
        * @since Series60 4.0
        * @return 
        *           
        */ 

		/**
		* Return all of the Services polices from SD only <wsp:Policy> tags
		* @param aPolicies
		* @return KErrNone
		*		  KErrNotFound	
		*/
        virtual TInt ServicePolicies(RPolicyArray& aPolicies) = 0;
        /**
        * Gets the Client Policy
        */
        virtual CSenElement* ClientPolicy() = 0;
        /**
        * Searches for the Client Policy with the given key value
        * @param aKey
        * @return ETrue If the Client Policy is present with the given key value
        *		  EFalse If the Client Policy is not present with the given key value  
        */
        virtual TBool ClientPolicy(const TDesC8& aKey) = 0;
        /**
        * Gets the Client Policy with the given key value
        * @param aKey
        * @return Client Policy Value is returned
        */
        virtual HBufC8* ClientPolicyValue(const TDesC8& aKey) = 0;
    };

#endif //M_SEN_POLICY_H

// End of File