ClientAppointment Class Reference
[Items]

Wraps the Outlook appointment object. More...

#include <ClientAppointment.h>

Inheritance diagram for ClientAppointment:
[legend]
Collaboration diagram for ClientAppointment:
[legend]

List of all members.

Public Member Functions

 ClientAppointment ()
 Constructor.
 ClientAppointment (const ClientAppointment &c)
ClientAppointment operator= (const ClientAppointment &c)
 ~ClientAppointment ()
 Destructor.
void setCOMPtr (_AppointmentItemPtr &ptr, const std::wstring &itemID)
 Set a COM pointer to this object: refresh all members.
void setCOMPtr (_AppointmentItemPtr &ptr)
_AppointmentItemPtr & getCOMPtr ()
 Returns a reference to the internal COM pointer.
ClientRecurrencegetRecPattern ()
 Returns a pointer to the internal ClientRecurrence object (NULL if not recurring).
int clearRecPattern ()
 Used to clear recurrence pattern.
int saveItem ()
int deleteItem ()
ClientItemcopyItem ()
 Returns a (new allocated) copy of this item.
void setRecurringTimezone (const TIME_ZONE_INFORMATION *tz)
const TIME_ZONE_INFORMATION & getRecurringTimezone () const
bool isAllDayEvent ()
 Returns TRUE if the event is a all-day.

Public Attributes

DATE localStartDate
DATE localEndDate

Private Member Functions

void createSafeAppointmentInstance ()
void initializeRecPattern ()
bool isSecureProperty (const std::wstring &propertyName)
bool isComplexProperty (const std::wstring &propertyName)
const std::wstring getSafeProperty (const std::wstring &propertyName)
const std::wstring getComplexProperty (const std::wstring &propertyName)
int setComplexProperty (const std::wstring &propertyName, const std::wstring &propertyValue)

Private Attributes

_AppointmentItemPtr pAppointment
 Pointer to microsoft outlook objects.
Redemption::ISafeAppointmentItemPtr pSafeAppointment
 Pointer to Redemption safe objects.
ClientRecurrence recPattern
 Internal Object: to manage recurrence pattern.
TIME_ZONE_INFORMATION timeZoneInfo
 The timezone information of the recurring appointment It is used ONLY when the app is recurring.


Detailed Description

Wraps the Outlook appointment object.

Implements methods to get/set specific properties for this object type. Contains a ClientRecurrence object that describes the recurrence pattern.


Member Function Documentation

int ClientAppointment::clearRecPattern (  ) 

Used to clear recurrence pattern.

Also removes any appointment exception (if exists). Throws a ClientException if operation fails. Returns 0 if no errors.

References ClientRecurrence::clearRecurrence(), getSafeItemName(), ClientItem::hr, pAppointment, recPattern, and throwClientException().

ClientItem * ClientAppointment::copyItem (  )  [virtual]

Returns a (new allocated) copy of this item.

Returns:
: a pointer to the new ClientItem object (must bee deleted by the caller). NULL in case of errors.

Implements ClientItem.

References ClientAppointment(), pAppointment, and setCOMPtr().

ClientRecurrence * ClientAppointment::getRecPattern (  ) 

Returns a pointer to the internal ClientRecurrence object (NULL if not recurring).

Returns a pointer to the internal ClientRecurrence object Returns NULL if it's not recurring.

References ClientRecurrence::isRecurring(), and recPattern.

Referenced by convertToSyncItem(), DateFilter::execute(), fillClientItem(), WindowsSyncSource::filterClientItem(), and setRecurrenceExceptions().

bool ClientAppointment::isAllDayEvent (  ) 

Returns TRUE if the event is a all-day.

Moves this ClientAppointment into the passed destination folder.

The move operation changes only the item location in Outlook, so the item's ID is preserved.

Parameters:
destFolder the destination ClientFolder to move this object to
Returns:
0 if no errors

References pAppointment, and vBoolToBool().

Referenced by convertToSyncItem().


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

Generated on Tue Apr 6 13:00:41 2010 for Funambol Outlook Plug-in Library by  doxygen 1.5.7.1