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: MBUtils ECOM definition

    15 *

    16 */

    17 #ifndef M_MRENTRYPROCESSOR_H

    18 #define M_MRENTRYPROCESSOR_H

    19 

    20 #include <e32base.h>

    21 #include <magnentryui.h>

    22 #include "esmrdef.h"

    23 #include "tesmrscenariodata.h"

    24 

    25 class MESMRCalEntry;

    26 class CCalEntry;

    27 class CCalInstance;

    28 

    29 /**

    30  * MESMREntryProcessor defines interface for entry processing

    31  */

    32 class MESMREntryProcessor

    33     {

    34 public:

    35     virtual ~MESMREntryProcessor() {}

    36         

    37 public: // Interface

    38     /**

    39      * Fetches scenario data.

    40      *

    41      * @return scenario data.

    42      */

    43     virtual const TESMRScenarioData& ScenarioData() const = 0;

    44 

    45     /**

    46      * Tests, whether processor contains entry, which it has processed

    47      * or not.

    48      *

    49      * @return ETrue, if contains processed entry.

    50      */

    51     virtual TBool ContainsProcessedEntry() const = 0;

    52 

    53     /**

    54      * Process entries and constructs scenario data.

    55      *

    56      * @param aParam AGN Entry UI input parameters.

    57      * @param aEntries Calendar entries to be processed.

    58      *        Ownership is not transferred.

    59      */

    60     virtual void ProcessL(

    61             const MAgnEntryUi::TAgnEntryUiInParams* aParams,

    62             RPointerArray<CCalEntry>* aEntries ) = 0;

    63 

    64     /**

    65      * Process entry and constructs scenario data.

    66      *

    67      * @param aParam AGN Entry UI input parameters.

    68      * @param aEntry Calendar entry to be processed.

    69      * @param aSetDefaultValuesToEntry, ETrue is default values

    70      * should be set to entry, EFalse otherwise

    71      * @param aTypeChanging entry type is changing

    72      */

    73     virtual void ProcessL(

    74             const MAgnEntryUi::TAgnEntryUiInParams* aParams,

    75             CCalEntry& aEntry,

    76             TBool aSetDefaultValuesToEntry,

    77             const TBool aTypeChanging = EFalse ) = 0;

    78     

    79     /**

    80      * Process entries. Scenario data is not constructed.

    81      *

    82      * @param aEntries Calendar entries to be processed.

    83      *        Ownership is not transferred.

    84      */

    85     virtual void ProcessL(

    86             RPointerArray<CCalEntry>* aEntries ) = 0;

    87 

    88     /**

    89      * Processes calendar instance. All operations affects only the

    90      * processed instance.

    91      *

    92      * @param aInstance Reference to calendar instance.

    93      */

    94     virtual void ProcessL(

    95             CCalInstance& aInstance ) = 0;

    96 

    97     /**

    98      * Switches processor for specified mode mode.

    99      * @error KErrNotReady no entries has been processed yet.

   100      * @error KErrArgument Unknown mode

   101      */

   102     virtual void SwitchProcessorToModeL(

   103             TMRProcessorMode aMode ) = 0;

   104 

   105     /**

   106      * Fetches ES MR Entry. Methods panics, if entries has not

   107      * been processed before calling this method.

   108      *

   109      * @return Reference to CESMRMeetingRequestEntry object.

   110      */

   111     virtual MESMRCalEntry& ESMREntryL() = 0;

   112 

   113     /**

   114      * Resets the entry processor. After calling this method the

   115      * processor is in the same state than after creation.

   116      */

   117     virtual void ResetL() = 0;

   118 

   119     /**

   120      * Process output parameters. Processing is done according to command

   121      * passed as parameter.

   122      *

   123      * @param aOutputParams Reference to output parameters.

   124      * @param aCommand Command for which output parameters are processed.

   125      */

   126     virtual void ProcessOutputParametersL(

   127             MAgnEntryUi::TAgnEntryUiOutParams& aOutParams,

   128             TESMRCommand aCommand ) = 0;

   129     

   130     /**

   131      * Returns extension interface.

   132      * @param aExtensionUid Extension identifier 

   133      */

   134     virtual TAny* Extension( TUid /* aExtensionUid */ ) { return NULL; }

   135     };

   136 

   137 #endif // M_MRENTRYPROCESSOR_H

   138 

   139 // EOF