1 /*

     2 * Copyright (c) 2007-2009 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:  Interface definition for ESMR task factory

    15 *

    16 */

    17 

    18 

    19 #ifndef MESMRTASKEXTENSION_H

    20 #define MESMRTASKEXTENSION_H

    21 

    22 #include <e32base.h>

    23 //<cmail>

    24 #include "esmrdef.h"

    25 //</cmail>

    26 

    27 class MESMRCalEntry;

    28 

    29 /**

    30  * MESMRTaskExtension is extension API for CMRUtils.

    31  * MESMRTaskExtension defines methods for executing ES MR MR related

    32  * functionality.

    33  *

    34  * Usage (assuming you have CMRUtils* iUtils):

    35  * MESMRTaskExtension* ext = ExtensionApiL<MESMRTaskExtension>( iUtils );

    36  *

    37  * @lib esmrtasks.lib

    38  */

    39 class MESMRTaskExtension

    40     {

    41 public: // Inline implementation

    42     /**

    43      * Fetches task extension uid.

    44      * @return task extension uid

    45      */

    46     inline static TUid ExtensionUid();

    47 

    48 public: // Destruction

    49     /**

    50      * Virtual C++ destructor.

    51      */

    52     virtual ~MESMRTaskExtension() { }

    53 

    54 public: // Interface

    55     /**

    56      * Sends and stores MR response. Command needs to be one of the

    57      * following:

    58      *  - EESMRCmdAcceptMR

    59      *  - EESMRCmdTentativeMR

    60      *  - EESMRCmdDeclineMR

    61      *

    62      * Phone owner's attendee status needs to match MR response command.

    63      *

    64      * @param aCommand Command to be executed

    65      * @param aEntry Reference to entry

    66      * @see TESMRCommand

    67      */

    68     virtual void SendAndStoreResponseL(

    69             TESMRCommand aCommand,

    70             MESMRCalEntry& aEntry ) = 0;

    71 

    72     /**

    73      * Sends and stores MR . Command needs to be one of the

    74      * following:

    75      *  - EESMRCmdSendMR

    76      *  - EESMRCmdSendMRUpdate

    77      *

    78      * Phone owner needs to be meeting organizer.

    79      *

    80      * @param aCommand Command to be executed

    81      * @param aEntry Reference to entry

    82      * @see TESMRCommand

    83      */

    84     virtual void SendAndStoreMRL(

    85             TESMRCommand aCommand,

    86             MESMRCalEntry& aEntry ) = 0;

    87 

    88     /**

    89      * Deletes MR from local calendar DB. Method also sends either cancellation

    90      * or decline message.

    91      *

    92      * Command needs to be one of the following:

    93      *  - EESMRCmdDeleteMR

    94      *

    95      * @param aCommand Command to be executed

    96      * @param aEntry Reference to entry

    97      * @see TESMRCommand

    98      */

    99     virtual void DeleteAndSendMRL(

   100             TESMRCommand aCommand,

   101             MESMRCalEntry& aEntry ) = 0;

   102 

   103     /**

   104      * Stores Cal Event to local calendar DB.

   105      *

   106      * Command needs to be one of the following:

   107      *  - EESMRCmdSaveMR

   108      *

   109      * @param aCommand Command to be executed

   110      * @param aEntry Reference to entry

   111      * @see TESMRCommand

   112      */

   113     virtual void StoreEntryToLocalDBL(

   114             TESMRCommand aCommand,

   115             MESMRCalEntry& aEntry ) = 0;

   116                         

   117     /**

   118      * Forwards MR as email. Email editor is launched with pre-filled

   119      * email message.

   120      *

   121      * Command needs to be one of the following:

   122      *  - EESMRCmdForwardAsMail

   123      *

   124      * @param aCommand Command to be executed

   125      * @param aEntry Reference to entry

   126      * @see TESMRCommand

   127      */

   128      virtual void ForwardMRAsEmailL(

   129             TESMRCommand aCommand,

   130             MESMRCalEntry& aEntry ) = 0;

   131 

   132      /**

   133       * Creates email reply for meeting request.

   134       * Email editor is launched with pre-filled

   135       * email message.

   136       *

   137       * Command needs to be one of the following:

   138       *  - EESMRCmdReply or EESMRCmdReplyAll

   139       *

   140       * @param aCommand Command to be executed

   141       * @param aEntry Reference to entry

   142       * @see TESMRCommand

   143       */

   144      virtual void ReplyAsEmailL(

   145             TESMRCommand aCommand,

   146             MESMRCalEntry& aEntry ) = 0;

   147      

   148      /**

   149       * Deletes calendar event from local calendar DB.

   150       *

   151       * Command needs to be one of the following:

   152       *  - EESMRCmdCalEntryUIDelete

   153       *  - EESMRCmdDeleteMR

   154       *  

   155       * @param aCommand Command to be executed

   156       * @param aEntry Reference to entry

   157       * @see TESMRCommand

   158       */      

   159      virtual void DeleteEntryFromLocalDBL(

   160              TESMRCommand aCommand,

   161              MESMRCalEntry& aEntry ) = 0;

   162      

   163      /**

   164       * Marks to-do event as done.

   165       *

   166       * Command needs to be one of the following:

   167       *  - EESMRCmdTodoMarkAsDone

   168       *

   169       * @param aCommand Command to be executed

   170       * @param aEntry Reference to entry

   171       * @see TESMRCommand

   172       */      

   173      virtual void MarkTodoAsDoneL(

   174              TESMRCommand aCommand,

   175              MESMRCalEntry& aEntry ) = 0;

   176      

   177      /**

   178       * Marks to-do event as not done.

   179       *

   180       * Command needs to be one of the following:

   181       *  - EESMRCmdTodoMarkAsNotDone

   182       *

   183       * @param aCommand Command to be executed

   184       * @param aEntry Reference to entry

   185       * @see TESMRCommand

   186       */      

   187      virtual void MarkTodoAsNotDoneL(

   188              TESMRCommand aCommand,

   189              MESMRCalEntry& aEntry ) = 0 ;

   190      

   191     /**

   192      * Moves entry to current database

   193      * 

   194      * Command needs to be one of following:

   195      *  - EESMRCmdSaveMR

   196      *  - EESMRCmdCalEntryUISave

   197      * @param aCommand Command to be executed

   198      * @param aEntry Reference to entry

   199      * @see TESMRCommand

   200      */      

   201     virtual void MoveEntryToCurrentDBL(

   202          TESMRCommand aCommand,

   203          MESMRCalEntry& aEntry ) = 0 ;

   204     };

   205 

   206 #include "mesmrtaskextension.inl"

   207 

   208 #endif  // MESMRTASKEXTENSION_H