javaextensions/pim/common/inc.s60/mpimeventadaptermanager.h
branchRCL_3
changeset 14 04becd199f91
equal deleted inserted replaced
13:f5050f1da672 14:04becd199f91
       
     1 /*
       
     2 * Copyright (c) 2008 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:  Event adapter interface, provides access to an Event list.
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPIMEVENTADAPTERMANAGER_H
       
    20 #define MPIMEVENTADAPTERMANAGER_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include "mpimadaptermanager.h"
       
    24 #include "pimrepeatrule.h"
       
    25 
       
    26 //  FORWARD DECLARATIONS
       
    27 class MPIMEventListAdapter;
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32  *  Provides access to a single todo list. See also \ref MPIMAdapterManager
       
    33  *  class description.
       
    34  */
       
    35 class MPIMEventAdapterManager
       
    36 {
       
    37 public:
       
    38     // Destructor
       
    39 
       
    40     /**
       
    41      * Destructor.
       
    42      */
       
    43     virtual ~MPIMEventAdapterManager()
       
    44     {
       
    45     }
       
    46 
       
    47 public:
       
    48     // New functions
       
    49 
       
    50     /**
       
    51      * Provides access to the \ref MPIMAdapterManager representation of
       
    52      * this object.
       
    53      *
       
    54      * @return The \ref MPIMAdapterManager representation of this object.
       
    55      */
       
    56     virtual MPIMAdapterManager* GetAdapterManager() = 0;
       
    57 
       
    58     /**
       
    59      * Provides the supported repeat rule fields for a given frequency.
       
    60      *
       
    61      * @param aFrequency A frequency.
       
    62      *
       
    63      * @return Supported repeat rule fields for \a aFrequency.
       
    64      *         If \a aFrequency is not supported, an empty array
       
    65      *         is returned.
       
    66      *         If \a aFrequency is supported but no fields are
       
    67      *         supported for it, an array with one element, a zero,
       
    68      *         is returned.
       
    69      *
       
    70      * @par Leaving:
       
    71      * @li \c KErrArgument - \a aFrequency is not a valid frequency.
       
    72      */
       
    73     virtual const CArrayFix<TPIMField>& GetSupportedRepeatRuleFieldsL(
       
    74         const TPIMRepeatRuleFrequency& aFrequency) = 0;
       
    75 
       
    76     /**
       
    77      * Provides the supported interval values for given frequency.
       
    78      *
       
    79      * @param aFrequency A frequency.
       
    80      *
       
    81      * @return Supported interval values for given frequency. If the
       
    82      *         interval field is not supported for given frequency,
       
    83      *         an empty array is returned.
       
    84      *
       
    85      * @par Leaving:
       
    86      * @li \c KErrArgument - \a aFrequency is not a valid frequency.
       
    87      */
       
    88     virtual const CArrayFix<TInt>& GetSupportedIntervalsL(
       
    89         const TPIMRepeatRuleFrequency& aFrequency) = 0;
       
    90 
       
    91 protected:
       
    92     // Non-public operations
       
    93 
       
    94     // Allow derivation with protected default constructor.
       
    95     MPIMEventAdapterManager()
       
    96     {
       
    97     }
       
    98 
       
    99 private:
       
   100     // Prohibited operations
       
   101 
       
   102     // Prohibit copy constructor.
       
   103     MPIMEventAdapterManager(const MPIMEventAdapterManager&)
       
   104     {
       
   105     }
       
   106 
       
   107     // Prohibit assigment operator.
       
   108     MPIMEventAdapterManager& operator=(const MPIMEventAdapterManager&)
       
   109     {
       
   110         return *this;
       
   111     }
       
   112 
       
   113 };
       
   114 
       
   115 #endif // MPIMEVENTADAPTERMANAGER_H
       
   116 // End of File
       
   117