emailservices/emailframework/commonlib/inc/mmrattendee.h
changeset 0 8466d47a6819
equal deleted inserted replaced
-1:000000000000 0:8466d47a6819
       
     1 /*
       
     2 * Copyright (c)  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:  MR organizer definition
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_MRINFOATTENDEE_H
       
    20 #define M_MRINFOATTENDEE_H
       
    21 
       
    22 #include <e32base.h>
       
    23 //<cmail>
       
    24 #include "mmrorganizer.h"
       
    25 //</cmail>
       
    26 
       
    27 /**
       
    28  * MRAttendee defines meeting request attendee.
       
    29 
       
    30  */
       
    31 class MMRAttendee : public MMROrganizer
       
    32     {
       
    33 public: // Enumerations and definitions
       
    34 
       
    35     /** Attendee role definition */
       
    36     enum TAttendeeRole
       
    37         {
       
    38         /** Attendee role is not set */
       
    39         EMRAttendeeNotSet,
       
    40         /** Attendee chairperson */
       
    41         EMRAttendeeChair,
       
    42         /** Required participant */
       
    43         EMRAttendeeParticipant,
       
    44         /** Optional participant */
       
    45         EMRAttendeeOptionalParticipant,
       
    46         /** Non participant */
       
    47         EMRAttendeeNonParticipant
       
    48         };
       
    49 
       
    50     /** Definition for attendee status */
       
    51     enum TAttendeeStatus
       
    52         {
       
    53         /** Action has not been set */
       
    54         EMRAttendeeActionNotSet,
       
    55         /** Action is required by attendee. */
       
    56         EMRAttendeeActionNeeded,
       
    57         /** Attendee has accepted request */
       
    58         EMRAttendeeActionAccepted,
       
    59         /** Attendee has tentatively accepted the request */
       
    60         EMRAttendeeActionTentative,
       
    61         /**  Attendee's presence is confirmed */
       
    62         EMRAttendeeActionConfirmed,
       
    63         /** Attendee has declined request */
       
    64         EMRAttendeeActionDeclined,
       
    65         /** The required action has been completed by attendee (i.e no actions required) */
       
    66         EMRAttendeeActionCompleted
       
    67         };
       
    68 
       
    69 public: // Destruction
       
    70 
       
    71     /**
       
    72      * Virtual destructor.
       
    73      */
       
    74     virtual ~MMRAttendee()  { }
       
    75 
       
    76 public: // Interface
       
    77 
       
    78     /**
       
    79      * Sets attendee role.
       
    80      * @param aRole Attendee role.
       
    81      * @exception System wide error code.
       
    82      */
       
    83     virtual void SetAttendeeRoleL(TAttendeeRole aRole ) = 0;
       
    84 
       
    85     /**
       
    86      * Fetches attendee role.
       
    87      * @return Attendee role.
       
    88      */
       
    89     virtual TAttendeeRole AttendeeRole() const = 0;
       
    90 
       
    91     /**
       
    92      * Sets attendee status.
       
    93      * @param aStatus Attendee status.
       
    94      * @exception System wide error code.
       
    95      */
       
    96     virtual void SetAttendeeStatusL( TAttendeeStatus& aStatus ) = 0;
       
    97 
       
    98     /**
       
    99      * Fetches attendee status.
       
   100      * @return attendee status.
       
   101      */
       
   102     virtual TAttendeeStatus AttendeeStatus() const = 0;
       
   103 
       
   104     /**
       
   105      * Sets whether or not a response was requested for this attendee.
       
   106      * @param aRsvp ETrue if a response was requested, EFalse if not.
       
   107      * @exception System wide error code.
       
   108      */
       
   109     virtual void SetResponseRequestedL( TBool aRsvp ) = 0;
       
   110 
       
   111     /**
       
   112      * Gets whether or not a response was requested for this attendee.
       
   113      * @return ETrue if a response was requested, EFalse if not.
       
   114      */
       
   115     virtual TBool ResponseRequested() const = 0;
       
   116     };
       
   117 
       
   118 
       
   119 #endif // M_MRINFOATTENDEE_H