epoc32/include/mw/msenservicepolicy.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: Service policy interface for serene   
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
#ifndef M_SEN_SERVICE_POLICY_H
williamr@2
    19
#define M_SEN_SERVICE_POLICY_H
williamr@2
    20
williamr@2
    21
//  INCLUDES
williamr@2
    22
#include <e32base.h> // for CActive
williamr@2
    23
#include <badesca.h>
williamr@2
    24
williamr@2
    25
#include "SenDomFragment.h"
williamr@2
    26
williamr@2
    27
typedef RPointerArray<CSenElement> RPolicyArray;
williamr@2
    28
williamr@2
    29
// FORWARD DECLARATION
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
/*
williamr@2
    33
*   <ServicePolicy>
williamr@2
    34
*       <ClientPolicy>
williamr@2
    35
*			<MetadataEndpoint>uri.1</MetadataEndpoint>
williamr@2
    36
*			<MetadataEndpoint>uri.2</MetadataEndpoint>
williamr@2
    37
*			<MetadataEndpoint>uri.3</MetadataEndpoint>
williamr@2
    38
*           <PolicyValue1/>				
williamr@2
    39
*           <PolicyValue2/>				
williamr@2
    40
*       </ClientPolicy>
williamr@2
    41
*       <PolicyArrray>
williamr@2
    42
*			<wsp:Policy1/>
williamr@2
    43
*			<wsp:Policy2/>
williamr@2
    44
*       </PolicyArrray>
williamr@2
    45
*   </ServicePolicy>
williamr@2
    46
*/
williamr@2
    47
class MSenServicePolicy
williamr@2
    48
    {
williamr@2
    49
    public: // New functions
williamr@2
    50
williamr@2
    51
        /**
williamr@2
    52
        * Adds a policy in SD
williamr@2
    53
        * Method is used to add a RAW policy obtained 
williamr@2
    54
        * by Network or some dynamic means
williamr@2
    55
        * @since Series60 4.0
williamr@2
    56
        * @param aPolicy is the Policy Element
williamr@2
    57
        */ 
williamr@2
    58
        virtual TInt AddPolicyL(CSenElement* aPolicy) = 0;
williamr@2
    59
williamr@2
    60
        /**
williamr@2
    61
        * Remove  a Policy from SD
williamr@2
    62
        * @param aPolicyName , Policy with this name will be removed from SD
williamr@2
    63
        * @return
williamr@2
    64
        *  - KErrNone 
williamr@2
    65
        
williamr@2
    66
        */ 
williamr@2
    67
        virtual TInt RemovePolicyL(TDesC8& aPolicyName) = 0;
williamr@2
    68
williamr@2
    69
        /**
williamr@2
    70
        * Method reads provider policy class instance values from given
williamr@2
    71
        * template. 
williamr@2
    72
        * @since Series60 4.0
williamr@2
    73
        * @param aTemplate from which the values are read.
williamr@2
    74
        * @return   
williamr@2
    75
        *           
williamr@2
    76
        */ 
williamr@2
    77
        virtual TInt RebuildServicePolicyFrom(MSenServicePolicy& aTemplate) = 0;
williamr@2
    78
        
williamr@2
    79
        /**
williamr@2
    80
        * Checks if policies match.
williamr@2
    81
        * @return ETrue if policies match, EFalse if not.
williamr@2
    82
        */
williamr@2
    83
        virtual TBool Accepts(MSenServicePolicy& aPolicyPattern) = 0;
williamr@2
    84
       
williamr@2
    85
        /**
williamr@2
    86
        * Getter for ServicePolicies
williamr@2
    87
        * @since Series60 4.0
williamr@2
    88
        * @return 
williamr@2
    89
        *           
williamr@2
    90
        */ 
williamr@2
    91
williamr@2
    92
		/**
williamr@2
    93
		* Return all of the Services polices from SD only <wsp:Policy> tags
williamr@2
    94
		* @param aPolicies
williamr@2
    95
		* @return KErrNone
williamr@2
    96
		*		  KErrNotFound	
williamr@2
    97
		*/
williamr@2
    98
        virtual TInt ServicePolicies(RPolicyArray& aPolicies) = 0;
williamr@2
    99
        /**
williamr@2
   100
        * Gets the Client Policy
williamr@2
   101
        */
williamr@2
   102
        virtual CSenElement* ClientPolicy() = 0;
williamr@2
   103
        /**
williamr@2
   104
        * Searches for the Client Policy with the given key value
williamr@2
   105
        * @param aKey
williamr@2
   106
        * @return ETrue If the Client Policy is present with the given key value
williamr@2
   107
        *		  EFalse If the Client Policy is not present with the given key value  
williamr@2
   108
        */
williamr@2
   109
        virtual TBool ClientPolicy(const TDesC8& aKey) = 0;
williamr@2
   110
        /**
williamr@2
   111
        * Gets the Client Policy with the given key value
williamr@2
   112
        * @param aKey
williamr@2
   113
        * @return Client Policy Value is returned
williamr@2
   114
        */
williamr@2
   115
        virtual HBufC8* ClientPolicyValue(const TDesC8& aKey) = 0;
williamr@2
   116
    };
williamr@2
   117
williamr@2
   118
#endif //M_SEN_POLICY_H
williamr@2
   119
williamr@2
   120
// End of File