meetingrequest/mrservices/inc/cesmrcaluserutil.h
changeset 0 8466d47a6819
child 12 4ce476e64c59
equal deleted inserted replaced
-1:000000000000 0:8466d47a6819
       
     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:  MR user utility class definition
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CESMRCALUSERUTIL_H
       
    20 #define CESMRCALUSERUTIL_H
       
    21 
       
    22 #include <e32base.h>
       
    23 //<cmail>
       
    24 #include "esmrdef.h"
       
    25 //</cmail>
       
    26 
       
    27 class CCalEntry;
       
    28 class CCalAttendee;
       
    29 
       
    30 /**
       
    31 * CESMRCalUserUtil provides services for handling
       
    32 * meeting request calendar users.
       
    33 *
       
    34 * @lib esmrservices.lib
       
    35 */
       
    36 NONSHARABLE_CLASS(CESMRCalUserUtil) : public CBase
       
    37     {
       
    38 public: // Construction and destruction
       
    39     /**
       
    40      * Creates new CESMRCalUserUtil object. Ownership
       
    41      * is transferred to caller.
       
    42      * @param aEntry Refernce to MR calendar entry
       
    43      * @return Pointer to created CESMRCalUserUtil object,
       
    44      */
       
    45      IMPORT_C static CESMRCalUserUtil* NewL( CCalEntry& aEntry );
       
    46     
       
    47     /**
       
    48      * Creates new CESMRCalUserUtil object. Ownership
       
    49      * is transferred to caller.
       
    50      * @param aEntry Refernce to MR calendar entry
       
    51      * @return Pointer to created CESMRCalUserUtil object,
       
    52      */
       
    53     IMPORT_C static CESMRCalUserUtil* NewLC( CCalEntry& aEntry );
       
    54 
       
    55     /**
       
    56      * C++ destructor
       
    57      */
       
    58     IMPORT_C ~CESMRCalUserUtil();
       
    59 
       
    60 public: // Interface
       
    61     /**
       
    62      * Fetches attendees from entry. Attendees are added to
       
    63      * aAttendeeArray. Attendees are filtered according to aFilterFlags
       
    64      * parameter.
       
    65      * Filtering flags is combimnation of enumeration TESMRRole values.
       
    66      * For example, aFilterFlags =  EESMRRoleRequiredAttendee --> Required
       
    67      * attendees are included to array. Ownership of the attendee objects is
       
    68      * not transferred.
       
    69      * @param aAttendeeArray Reference to attendee array
       
    70      * @param aFilterFlags Attendee filtering flags.
       
    71      */
       
    72     IMPORT_C void GetAttendeesL(
       
    73             RArray<CCalAttendee*>& aAttendeeArray,
       
    74             TUint aFilterFlags ) const;
       
    75 
       
    76     /**
       
    77      * Fetches the phone owner's attendee role in this calendar entry.
       
    78      * @return User role.
       
    79      * @see TESMRRole.
       
    80      */
       
    81     IMPORT_C TESMRRole PhoneOwnerRoleL() const;
       
    82 
       
    83 private: // Implementation
       
    84     CESMRCalUserUtil( CCalEntry& aEntry );
       
    85     void ConstructL();
       
    86 
       
    87 private: // Data
       
    88     /// Own: Reference to calendar entry
       
    89     CCalEntry& iEntry;
       
    90     };
       
    91 
       
    92 #endif // CESMRCALUSERUTIL_H
       
    93 
       
    94 // EOF