CComponentDetails Class Reference

This class holds the complete the information about the Components. Will be used when UI/other parties needs the full details of component. More...

#include <CComponentDetails.h>

Inheritance diagram for CComponentDetails:

Public Member Functions
	CComponentDetails ()
	CComponentDetails (string description)
	CComponentDetails (string summary, int tododue, int status)
	CComponentDetails (string summary, string description, string location, int dateStart, int dateEnd)
void	initEvent ()
	CComponentDetails (CComponentDetails &ref)
const CComponentDetails &	operator= (const CComponentDetails &right)
bool	setClas (string szClas)
string	getClas ()
bool	setDateStamp (int iDateStamp)
int	getDateStamp ()
bool	setOrganizer (COrganizer *pOrg)
COrganizer *	getOrganizer ()
bool	setAttendees (vector< CAttendee * > vAttendeeList)
vector< CAttendee * >	getAttendees ()
bool	setAttachments (vector< string > vAttachList)
vector< string >	getAttachments ()
bool	setSequence (int iSequence)
int	getSequence ()
bool	setUid (int iUId)
int	getUid ()
bool	setUrl (string szUrl)
string	getUrl ()
bool	setCategories (string szCategories)
string	getCategories ()
bool	setComments (string szComments)
string	getComments ()
bool	setContact (string szContact)
string	getContact ()
bool	setRelated (string szRelated)
string	getRelated ()
bool	setResources (string szResources)
string	getResources ()
vector< CAttendee * >	retrieveAttendeeDetails ()
COrganizer *	retrieveOrganizerDetails ()
bool	setXProperties (vector< CProperties * >)
vector< CProperties * >	getXProperties ()
virtual	~CComponentDetails ()
	CComponentDetails (string sId, int iType, int iFlags, string szSummary, string szDescription, string szLocation, int iStatus, int iDateStart, int iDateEnd, int iLastModified, int iCreatedTime, int iDatestamp, COrganizer *pOrganizer, vector< CAttendee * >vAttendee, vector< string >vAttachements, int iSequence, int iUId, string szUrl, string szCategory, string szComments, string szContacts, string szRelated, string szResources, vector< CProperties * >vXProp, map< string, vector< CParameters * > > hashMap)
map< string, vector< CParameters * > >	getHashMap ()
bool	setHashMap (map< string, vector< CParameters * > > hashMap)
map< string, vector< CParameters * > >	retrieveParameterDetails ()
vector< CParameters * >	getParameter (QueryResult *pQr)
vector< CProperties * >	retrieveXPropertyDetails ()
vector< string >	getPropertyValues (string szProperty)
CAttendee *	convertParamToAttendee (vector< CParameters * > vParam)
vector< CParameters * >	getParameter (string szPropName, string szPropValue)
COrganizer *	convertParamToOrganizer (vector< CParameters * > vParam)
Private Attributes
int	iDateStamp
COrganizer *	pOrganizer
vector< string >	vAttachments
vector< CAttendee * >	vAttendee
int	iSequence
int	iUId
string	szUrl
string	szCategory
string	szComments
string	szContacts
string	szRelated
string	szResources
vector< CProperties * >	vXProp
string	szClas
map< string, vector< CParameters * > >	hashMap

---

Detailed Description

This class holds the complete the information about the Components. Will be used when UI/other parties needs the full details of component.

CComponentDetails class

---

Constructor & Destructor Documentation

CComponentDetails::CComponentDetails

(

)

CComponentDetails Default constructor

CComponentDetails::CComponentDetails

(

string

szDescription

)

CComponentDetails Overloaded parameterized constructor

CComponentDetails::CComponentDetails	(	string	szSummary,
		int	iTodoDue,
		int	iStatus
	)

CComponentDetails Overloaded parameterized constructor

CComponentDetails::CComponentDetails	(	string	szSummary,
		string	szDescription,
		string	szLocation,
		int	iDateStart,
		int	iDateEnd
	)

CComponentDetails Overloaded parameterized constructor

CComponentDetails::CComponentDetails

(

CComponentDetails &

ref

)

CComponent copy constructor

CComponentDetails::~CComponentDetails

(

)

[virtual]

Destructor

CComponentDetails::CComponentDetails	(	string	sId,
		int	iType,
		int	iFlags,
		string	szSummary,
		string	szDescription,
		string	szLocation,
		int	iStatus,
		int	iDateStart,
		int	iDateEnd,
		int	iLastModified,
		int	iCreatedTime,
		int	iDatestamp,
		COrganizer *	pOrganizer,
		vector< CAttendee * >	vAttendee,
		vector< string >	vAttachements,
		int	iSequence,
		int	iUId,
		string	szUrl,
		string	szCategory,
		string	szComments,
		string	szContacts,
		string	szRelated,
		string	szResources,
		vector< CProperties * >	vXProp,
		map< string, vector< CParameters * > >	hashMap
	)

Paramterized constructor

---

Member Function Documentation

void CComponentDetails::initEvent

(

)

InitEvent Function used to initialize the class members

const CComponentDetails & CComponentDetails::operator=

(

const CComponentDetails &

right

)

overloaded assignment operator

bool CComponentDetails::setClas

(

string

szClas

)

Parameters:

string Class

Returns:

: bool indicating result of operation

This function is used to set class parameter for an entry (Event,todo)

string CComponentDetails::getClas

(

)

Parameters:

none

Returns:

: string class

This function is used to get class string

bool CComponentDetails::setDateStamp

(

int

iDateStamp

)

Parameters:

int time in utc

Returns:

: bool indicating result of operation

This function is used to setDateStamp

int CComponentDetails::getDateStamp

(

)

Parameters:

none

Returns:

:int datestamp in utc

This function is used to get date stamp

bool CComponentDetails::setOrganizer

(

COrganizer *

pOrg

)

Parameters:

COrganizer* pointer to COrganizer object

Returns:

: bool indicating result of operation

This function is used to set organizer

COrganizer * CComponentDetails::getOrganizer

(

)

Parameters:

none

Returns:

: COrganizer* pointer to Organizer class

This function is used to get Xproperties

bool CComponentDetails::setAttendees

(

vector< CAttendee * >

vAttendeeList

)

Parameters:

vector<CAttendee*> vector of pointers to CAttendee objets

Returns:

: bool indicating result of operation

This function is used to set Attendees

vector< CAttendee * > CComponentDetails::getAttendees

(

)

Parameters:

none

Returns:

: vector<CAttendee*> vector of pointers to CAttendee class

This function is used to get vector of pointers to CAttendee class

bool CComponentDetails::setAttachments

(

vector< string >

vAttachList

)

Parameters:

vector<string> vector of Attachments

Returns:

: bool indicating result of operation

TODO: have to change this to string This function is used to set Attachments

vector< string > CComponentDetails::getAttachments

(

)

Parameters:

none

Returns:

: vector<string> vector of attachments

This function is used to get attachments

bool CComponentDetails::setSequence

(

int

iSequence

)

Parameters:

int sequence

Returns:

: bool indicating result of operation

This function is used to set sequence

int CComponentDetails::getSequence

(

)

Parameters:

none

Returns:

: int sequence

This function is used to get sequence

bool CComponentDetails::setUid

(

int

iUId

)

Parameters:

int uid

Returns:

: bool indicating result of operation

This function is used to set uid

int CComponentDetails::getUid

(

)

Parameters:

none

Returns:

: int Uid

This function is used to get Uid might be needed from sync point of view

bool CComponentDetails::setUrl

(

string

szUrl

)

Parameters:

string url

Returns:

: bool indicating result of operation

This function is used to set url

string CComponentDetails::getUrl

(

)

Parameters:

none

Returns:

: string url

This function is used to get url string

bool CComponentDetails::setCategories

(

string

szCategories

)

Parameters:

string szCategories

Returns:

: bool indicating result of operation true/false

This function is used to set categories

string CComponentDetails::getCategories

(

)

Parameters:

none

Returns:

: string Categories

This function is used to get categories string

bool CComponentDetails::setComments

(

string

szComments

)

Parameters:

string comments

Returns:

: bool indicating result of operation

This function is used to set comments

string CComponentDetails::getComments

(

)

Parameters:

none

Returns:

: string comments

This function is used to get comments

bool CComponentDetails::setContact

(

string

szContact

)

Parameters:

string contact

Returns:

: bool indicating result of operation

This function is used to set contact

string CComponentDetails::getContact

(

)

Parameters:

none

Returns:

: string contact

This function is used to get Contact

bool CComponentDetails::setRelated

(

string

szRelated

)

Parameters:

string Related

Returns:

: bool indicating result of operation

This function is used to set Related

string CComponentDetails::getRelated

(

)

Parameters:

none

Returns:

: string related

This function is used to get related

bool CComponentDetails::setResources

(

string

szResources

)

Parameters:

string Resources

Returns:

: bool indicating result of operation

This function is used to set Resources

string CComponentDetails::getResources

(

)

Parameters:

none

Returns:

: string Resources

This function is used to get resources

vector< CAttendee * > CComponentDetails::retrieveAttendeeDetails

(

)

Parameters:

NONE

Returns:

vector<CAttendee*> vector of CAttendee pointers

Memory is alocated inside the procedure for each of the CAttendee has to be freed by the API user. Function used to retrieve Attendee details from DB

COrganizer * CComponentDetails::retrieveOrganizerDetails

(

)

Parameters:

NONE

Returns:

COrganizer*

Function used to retrieve organizer details Memory is allocated inside the prodcedure for COrganizer has to be freed by the API user.

bool CComponentDetails::setXProperties

(

vector< CProperties * >

)

Parameters:

string

Xproperties

Returns:

bool indicating result of operation

This function is used to set Xproperties

vector< CProperties * > CComponentDetails::getXProperties

(

)

Parameters:

none

Returns:

vector <CProperties*> vector of Cpropertied

This function is used to get Xproperties

map< string, vector< CParameters * > > CComponentDetails::getHashMap

(

)

Parameters:

NONE

Returns:

: map <string, vector <CParameters*> >

This function is used to get the hash map from the CComponentDetails object.

bool CComponentDetails::setHashMap

(

map< string, vector< CParameters * > >

hashMap

)

Parameters:

hashmap

Returns:

bool

This function is used to set the hashmap in CComponentDetails object.

map< string, vector< CParameters * > > CComponentDetails::retrieveParameterDetails

(

)

Parameters:

:

NONE

Returns:

: map with string and vector <CParameters*> as (key,value)

This function retrieves details from parameters table and returns a hashmap. Memory for vector <CParameters*> will be allocated inside this procedure has to be freed by the API user.

vector< CParameters * > CComponentDetails::getParameter

(

QueryResult *

pQr

)

Parameters:

QueryResult pQr

Returns:

: vector < CParameters* >

This function returns all cparameters.

vector< CProperties * > CComponentDetails::retrieveXPropertyDetails

(

)

Parameters:

NONE

Returns:

: vector <CProperties*> vector of extra properties if any for this event

Memory is allocated for vector <CProperties*> inside this procedure has to be freed by the API user. Function to retrieve xtra properties.

vector< string > CComponentDetails::getPropertyValues

(

string

szProperty

)

Parameters:

string

Property Name

Returns:

vector<string> vector of unique Property values for specific ID

Function used to retrieve MailTo parameters for attendee

CAttendee * CComponentDetails::convertParamToAttendee

(

vector< CParameters * >

vParam

)

Parameters:

vector

<CParameters *>

Returns:

CAttendee *

Function to convet vector of parameters to CAttendee

vector< CParameters * > CComponentDetails::getParameter	(	string	szPropName,
		string	szPropValue
	)

Parameters:

	string
	string

Returns:

vector <CParameters*>

Function to retrieve parameters for a particular property This is an overloaded method.

define SELECT_PROP_AND select * from Parametes where ComponentId= AND PropertyName = s AND PropertyValue = s

COrganizer * CComponentDetails::convertParamToOrganizer

(

vector< CParameters * >

vParam

)

Parameters:

@return

Function to convert vector of parameters to COrganizer

---

Field Documentation

int CComponentDetails::iDateStamp [private]

Datestamp

COrganizer* CComponentDetails::pOrganizer [private]

Organizer details

vector< string > CComponentDetails::vAttachments [private]

Attachments

vector< CAttendee *> CComponentDetails::vAttendee [private]

Attendee

int CComponentDetails::iSequence [private]

Sequence

int CComponentDetails::iUId [private]

Uid

string CComponentDetails::szUrl [private]

Url

string CComponentDetails::szCategory [private]

Component category

string CComponentDetails::szComments [private]

Comments

string CComponentDetails::szContacts [private]

Contacts

string CComponentDetails::szRelated [private]

Related

string CComponentDetails::szResources [private]

Resources

vector<CProperties*> CComponentDetails::vXProp [private]

XProperties

string CComponentDetails::szClas [private]

Class

---

The documentation for this class was generated from the following files:

• include/CComponentDetails.h
• src/CComponentDetails.cpp

---