CAttendee Class Reference

This class contains the API's to store the attendee details in database. More...

#include <CAttendee.h>

Inheritance diagram for CAttendee:

CParticipant

Public Member Functions

 CAttendee (CAttendee &ref)
 CAttendee ()
 ~CAttendee ()
const CAttendee & operator= (const CAttendee &right)
bool setCalendarUserType (CalendarUserType iCalendarUserType)
CalendarUserType getCalendarUserType ()
bool setMember (string szMember)
string getMember ()
bool setRole (ParticipantRole iParticipantRole)
ParticipantRole getRole ()
bool setParticipationStatus (ParticipantStatus iParticipantStatus)
ParticipantStatus getParticipationStatus ()
bool setRSVP (bool bRsvp)
bool getRSVP ()
bool setDelegatees (string szDelegatees)
string getDelegatees ()
bool setDelegator (string szDelegator)
string getDelegator ()
string toString ()

Private Attributes

string szMember
ParticipantRole iParticipantRole
ParticipantStatus iParticipantStatus
bool bRsvp
string szDelegatees
string szDelegators
CalendarUserType iCalendarUserType

Detailed Description

This class contains the API's to store the attendee details in database.

CAttendee

Constructor & Destructor Documentation

CAttendee::CAttendee ( CAttendee &  ref  ) 

copy Constructor

References bRsvp, iCalendarUserType, iParticipantRole, iParticipantStatus, szDelegatees, szDelegators, and szMember.

CAttendee::CAttendee (  ) 

CAttendee default constructor

Parameters:
none 
Returns:
none
default constructor

CAttendee::~CAttendee (  ) 

~CAttendee default destructor

Parameters:
none 
Returns:
none
default destructor

Member Function Documentation

const CAttendee & CAttendee::operator= ( const CAttendee &  right  ) 

overloaded assignment operator

References bRsvp, iCalendarUserType, iParticipantRole, iParticipantStatus, CParticipant::operator=(), szDelegatees, szDelegators, and szMember.

bool CAttendee::setCalendarUserType ( CalendarUserType  iCUType  ) 

Parameters:
CalendarUserType type of calendar user
Returns:
bool
This function will be used to set type of calendar user the calendarUserType can be "INDIVIDUAL" ; An individual "GROUP" ; A group of individuals "RESOURCE" ; A physical resource "ROOM" ; A room resource "UNKNOWN" ; Otherwise not known x-name ; Experimental type iana-token) ; Other IANA registered Default is INDIVIDUAL

setCalendarUserType

Parameters:
icuType type of calendar user is an enumerated type
Returns:
bool
This function will be used to set type of calendar user the calendarUserType can be "INDIVIDUAL" ; An individual / "GROUP" ; A group of individuals / "RESOURCE" ; A physical resource / "ROOM" ; A room resource / "UNKNOWN" ; Otherwise not known / x-name ; Experimental type / iana-token) ; Other IANA registered

References iCalendarUserType.

Referenced by CComponentDetails::convertParamToAttendee(), and ICalConverter::getAttendeeFromIcal().

CalendarUserType CAttendee::getCalendarUserType (  ) 

Parameters:
none 
Returns:
CalendarUserType type of calendar user
This function will be used to get the type of calendar user which has been previously set using setCalendarUserType().

getCalendarUserType

Parameters:
none 
Returns:
int type of calendar user
This function will be used to get the type of calendar user which has been previously set using setcalendarUserType().

References iCalendarUserType.

Referenced by ICalConverter::getIcalAttendee_ical(), and toString().

bool CAttendee::setMember ( string  szMember  ) 

Parameters:
string szMember member name
Returns:
bool
This function will be used to set member name. Member indicates the groups that attendee belongs to. returns true when member name is set correctly.

setMember

Parameters:
string member name
Returns:
bool
This function will be used to set member name. Member indicates the groups that attendee belongs to. returns true when member name is set correctly.

Referenced by CComponentDetails::convertParamToAttendee().

string CAttendee::getMember (  ) 

Parameters:
none 
Returns:
string name of the member
This function will be used to get the member which has been previously set using setCalendarUserType(). member indicates the groups that attendee belongs to.

getMember

Parameters:
none 
Returns:
string name of the member
This function will be used to get the member which has been previously set using setcalendarUserType(). member indicates the groups that attendee belongs to.

References szMember.

Referenced by ICalConverter::getIcalAttendee_ical().

bool CAttendee::setRole ( ParticipantRole  iRole  ) 

Parameters:
ParticipantRole iParticipantRole role of participant
Returns:
bool
This function will be used to set role that the attendee will have in the calendar component. returns true when role is set correctly.

setRole

Parameters:
int iRole
Returns:
bool
This function will be used to set role that the attendee will have in the calendar component. returns true when role is set correctly.

References iParticipantRole.

Referenced by CComponentDetails::convertParamToAttendee(), and ICalConverter::getAttendeeFromIcal().

ParticipantRole CAttendee::getRole (  ) 

Parameters:
none 
Returns:
string role of attendee.
This function will be used to get the role which has been previously set using setRole().

getRole

Parameters:
none 
Returns:
string role of attendee.
This function will be used to get the role which has been previously set using setRole().

References iParticipantRole.

Referenced by ICalConverter::getIcalAttendee_ical(), ICalConverter::getIcalAttendee_vcal(), and toString().

bool CAttendee::setParticipationStatus ( ParticipantStatus  iStatus  ) 

Parameters:
ParticipantStatus iParticipantStatus status of the attendee's participation
Returns:
bool
This function will be used to set status of the attendee's participation. returns true when is status is set correctly.

setParticipationStatus

Parameters:
string status of the attendee's participation
Returns:
bool
This function will be used to set status of the attendee's participation. returns true when is status is set correctly.

References iParticipantStatus.

Referenced by CComponentDetails::convertParamToAttendee().

ParticipantStatus CAttendee::getParticipationStatus (  ) 

Parameters:
none 
Returns:
ParticipantStatus status of the attendee's participation
This function will be used to get status of the attendee's participation which has been previously set using setParticipationStatus().

getParticipationStatus

Parameters:
none 
Returns:
string status of the attendee's participation
This function will be used to get status of the attendee's participation which has been previously set using setparticipationStatus().

References iParticipantStatus.

Referenced by ICalConverter::getIcalAttendee_ical(), and toString().

bool CAttendee::setRSVP ( bool  brsvp  ) 

Parameters:
bool brsvp indicating whether the favour of a reply is requested
Returns:
bool
This function will be used to set RSVP which indicates whether the favour of a reply is requested or not. returns true when RSVP is set correctly.

setRSVP

Parameters:
string indicating whether the favour of a reply is requested
Returns:
bool rsvp
This function will be used to set RSVP1 which indicates whether the favour of a reply is requested or not. returns true when RSVP is set correctly.

References bRsvp.

Referenced by CComponentDetails::convertParamToAttendee(), and ICalConverter::getAttendeeFromIcal().

bool CAttendee::getRSVP (  ) 

Parameters:
none 
Returns:
bool RSVP value
This function will be used to get RSVP which has been previously set using setRSVP().

getRSVP

Parameters:
none 
Returns:
bool RSVP
This function will be used to get RSVP which has been previously set using setRSVP().

References bRsvp.

Referenced by ICalConverter::getIcalAttendee_ical(), ICalConverter::getIcalAttendee_vcal(), and toString().

bool CAttendee::setDelegatees ( string  szDelegatees  ) 

Parameters:
string calendar users
Returns:
bool
This function will be used to set DELEGATED-TO which indicates the calendar users that the orignal request was delegated to. returns true when Delegated to is set correctly.

setDelagatees

Parameters:
string list of Delegatees
Returns:
bool
This function will be used to set DELEGATED-TO which indicates the calendar users that the orignal request was delegated to. returns true when Delegated to is set correctly.

Referenced by CComponentDetails::convertParamToAttendee(), and ICalConverter::getAttendeeFromIcal().

string CAttendee::getDelegatees (  ) 

Parameters:
none 
Returns:
string users
This function will be used to get calendar users that the original request was delegated to which has been previously set using setDelegatees().

getDelelegatees

Parameters:
none 
Returns:
string users
This function will be used to get calendar users that the original request was delegated to which has been previously set using setdelegatees().

References szDelegatees.

Referenced by ICalConverter::getIcalAttendee_ical().

bool CAttendee::setDelegator ( string  szDelegators  ) 

Parameters:
string calendar user
Returns:
bool
This function will be used to set DELEGATED-FROM which indicates whom the request was delegated from returns true when Delegated from is set correctly.

setDelegator

Parameters:
string calendar user
Returns:
bool
This function will be used to set DELEGATED-FROM which indicates whom the request was delegated from returns true when Delegated from is set correctly.

Referenced by CComponentDetails::convertParamToAttendee(), and ICalConverter::getAttendeeFromIcal().

string CAttendee::getDelegator (  ) 

Parameters:
none 
Returns:
string user
This function will be used to get DELEGATED-FROM which indicates whom the request was delegated from which has been previously set using setDelegators().

getDelegator

Parameters:
none 
Returns:
string user
This function will be used to get DELEGATED-FROM which indicates whom the request was delegated from which has been previously set using setdelegators().

References szDelegators.

Referenced by ICalConverter::getIcalAttendee_ical().

string CAttendee::toString (  ) 

toString

Reimplemented from CParticipant.

References CParticipant::getCalAddress(), getCalendarUserType(), CParticipant::getCommonName(), CParticipant::getDirectoryParameter(), CParticipant::getLanguage(), CParticipant::getMailTo(), getParticipationStatus(), getRole(), getRSVP(), CParticipant::getSentBy(), CParticipant::getXparameters(), szDelegatees, szDelegators, and szMember.

Field Documentation

string CAttendee::szMember [private]

Attendee name

Referenced by CAttendee(), getMember(), operator=(), and toString().

ParticipantRole CAttendee::iParticipantRole [private]

Attendee role

Referenced by CAttendee(), getRole(), operator=(), and setRole().

ParticipantStatus CAttendee::iParticipantStatus [private]

Attendee status

Referenced by CAttendee(), getParticipationStatus(), operator=(), and setParticipationStatus().

bool CAttendee::bRsvp [private]

RSVP parameter

Referenced by CAttendee(), getRSVP(), operator=(), and setRSVP().

string CAttendee::szDelegatees [private]

Delegatees

Referenced by CAttendee(), getDelegatees(), operator=(), and toString().

string CAttendee::szDelegators [private]

Delegators

Referenced by CAttendee(), getDelegator(), operator=(), and toString().

CalendarUserType CAttendee::iCalendarUserType [private]

User type

Referenced by CAttendee(), getCalendarUserType(), operator=(), and setCalendarUserType().

The documentation for this class was generated from the following files:
Generated on Tue Jul 27 14:17:49 2010 for calendar-backend by  doxygen 1.5.6