javacommons/security/legacysupport/midp2userpreferences/inc/MUserPreferences.h
changeset 21 2a9601315dfc
equal deleted inserted replaced
18:e8e63152f320 21:2a9601315dfc
       
     1 /*
       
     2 * Copyright (c) 2003-2004 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 /**
       
    20  *
       
    21  * @file    MUserPreferences.h
       
    22  *
       
    23  * @internalComponent
       
    24  *
       
    25  */
       
    26 
       
    27 #ifndef MUSERPREFERENCES_H
       
    28 #define MUSERPREFERENCES_H
       
    29 
       
    30 #include <e32std.h>
       
    31 
       
    32 namespace MIDP
       
    33 {
       
    34 class MMIDletSuiteInfo;
       
    35 class MSecurityPreferences;
       
    36 class MMIDletSuiteUserPreferences;
       
    37 class MMIDletSuiteUserPreferencesIterator;
       
    38 class MMIDletSuiteCustomAttributes;
       
    39 
       
    40 /**
       
    41  *
       
    42  * An abstract operational interface to the user's per MIDlet suite preferences.
       
    43  *
       
    44  */
       
    45 
       
    46 class MUserPreferences
       
    47 {
       
    48 public:
       
    49 
       
    50     virtual ~MUserPreferences() = 0;
       
    51 
       
    52     /**
       
    53      *
       
    54      * Returns the security preferences for a given MIDlet suite.
       
    55      *
       
    56      * Ownership of the returned object is transferred to the caller.
       
    57      *
       
    58      * @param aInfo information identifying the MIDlet suite
       
    59      *
       
    60      * @return the security preferences for the given MIDlet suite,
       
    61      *         if any.
       
    62      *
       
    63      *         [Ownership of the returned object is transferred to the caller].
       
    64      *
       
    65      */
       
    66 
       
    67     virtual MSecurityPreferences* SecurityPreferencesL(const MMIDletSuiteInfo& aInfo) = 0;
       
    68 
       
    69     /**
       
    70      *
       
    71      * Returns an iterator which can be used to iterate over the user
       
    72      * preferences for all installed MIDlet suites.
       
    73      *
       
    74      * @return a preferences iterator
       
    75      *
       
    76      * [Ownership of the returned object is transferred to the caller].
       
    77      *
       
    78      */
       
    79 
       
    80     virtual MMIDletSuiteUserPreferencesIterator* IteratorL(void) = 0;
       
    81 
       
    82     /**
       
    83      * Returns the custom attributes of the given MIDlet suite.
       
    84      * The custom attributes are modifiable.
       
    85      *
       
    86      * Ownership of the returned object is transferred to the caller.
       
    87      *
       
    88      * @param aSuiteId the Id of the MIDlet suite
       
    89      *
       
    90      * @return the custom attributes of the given MIDlet suite
       
    91      *
       
    92      *  [Ownership of the returned object is transferred to the caller].
       
    93      *
       
    94      */
       
    95 
       
    96     virtual MMIDletSuiteCustomAttributes* CustomAttributesL(TUint32 aSuiteId) = 0;
       
    97 
       
    98 };
       
    99 
       
   100 inline MUserPreferences::~MUserPreferences()
       
   101 {
       
   102 }
       
   103 
       
   104 } // end of namespace MIDP
       
   105 
       
   106 #endif // MUSERPREFERENCES_H