epoc32/include/mw/senidentityprovideridarray8.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

/*
* 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:        Array utility class for listing pre-known ProviderIDs
*
*/








#ifndef SEN_IDENTITY_PROVIDER_ID_ARRAY_8_H
#define SEN_IDENTITY_PROVIDER_ID_ARRAY_8_H

//  INCLUDES
#include <e32base.h>
#include <badesca.h>
#include <e32std.h>
#include <MSenIdentityProviderIdArray.h>

// CLASS DECLARATION

/**
*  Array utility class for listing pre-known ProviderIDs
*  Typical use of this class is to define a strict list
*  of ProviderIDs pointing to certain IDPs, which are to
*  be accepted as only suitable services when initiating
*  an new service connection.
*  Other possiblity is to instantiate a non-strict array,
*  which only acts as "recommendation" of those Identity
*  Providers, that should be first checked when initiating
*  new service connection. In such case, because it is a
*  non-strict list, also other IDPs may be used, if none
*  matching with this "recommendation" is found.
*  @lib SenServDesc.lib
*  @since Series60 3.0
*/
class CSenIdentityProviderIdArray8 :    public CDesC8ArraySeg,
                                        public MSenIdentityProviderIdArray
{
    public:  // Constructors and destructor
        
        /**
        *   Constructor with no arguments create non-strict arrays.. 
        *   (iStrict = EFalse)
        */ 
        IMPORT_C static CSenIdentityProviderIdArray8* NewL();

        /**
        *   Constructor with no arguments create non-strict arrays.. 
        *   (iStrict = EFalse)
        */ 
        IMPORT_C static CSenIdentityProviderIdArray8* NewLC();

        /**
        * Basic constructor with a default value for iStrict.
        * @since Series60 3.0
        * @param aStrict the value to be set to iStrict
        */
        IMPORT_C static CSenIdentityProviderIdArray8* NewL(const TBool aStrict);

        /**
        * Basic constructor with a default value for iStrict.
        * @since Series60 3.0
        * @param aStrict the value to be set to iStrict
        */
        IMPORT_C static CSenIdentityProviderIdArray8* NewLC(const TBool aStrict);

        /**
        * Destructor.
        */
        IMPORT_C virtual ~CSenIdentityProviderIdArray8();

        // Functions from base classes

        // From MSenIdentityProviderIdArray
        
        /**
        * Getter for iStrict
        * @since Series60 3.0
        * @return ETrue if iStrict is true, otherwise EFalse
        */
        IMPORT_C virtual TBool IsStrict() const;
        
        /**
        * Setter for iStrict
        * @since Series60 3.0
        * @param aStrict the value to be set to iStrict
        */
        IMPORT_C void SetStrict(TBool aStrict);
        
    protected:  // New functions
        
        /**
        * C++ default constructor.
        */
        CSenIdentityProviderIdArray8(const TBool aStrict);  
        
        /**
        * Default 2nd phase constructor
        * @since Series60 3.0
        */
        void ConstructL();

    private:    // Data
        TBool iStrict;         
    };
    
#endif // SEN_IDENTITY_PROVIDER_ID_ARRAY_8_H

// End of File