libkcal

KCal::Scheduler Class Reference

#include <scheduler.h>

Inheritance diagram for KCal::Scheduler:

KCal::DummyScheduler KCal::IMIPScheduler List of all members.

Detailed Description

This class provides an encapsulation of iTIP transactions.

It is an abstract base class for inheritance by implementations of the iTIP scheme like iMIP or iRIP.

Definition at line 97 of file scheduler.h.


Public Types

 Publish
 Request
 Refresh
 Cancel
 Add
 Reply
 Counter
 Declinecounter
 NoMethod
enum  Method {
  Publish, Request, Refresh, Cancel,
  Add, Reply, Counter, Declinecounter,
  NoMethod
}

Public Member Functions

 Scheduler (Calendar *calendar)
virtual bool publish (IncidenceBase *incidence, const QString &recipients)=0
virtual bool performTransaction (IncidenceBase *incidence, Method method)=0
virtual bool performTransaction (IncidenceBase *incidence, Method method, const QString &recipients)=0
virtual QPtrList< ScheduleMessageretrieveTransactions ()=0
bool acceptTransaction (IncidenceBase *, Method method, ScheduleMessage::Status status)
virtual bool deleteTransaction (IncidenceBase *incidence)
virtual QString freeBusyDir ()=0
void setFreeBusyCache (FreeBusyCache *)
FreeBusyCachefreeBusyCache () const

Static Public Member Functions

static QString methodName (Method)
static QString translatedMethodName (Method)

Protected Member Functions

bool acceptPublish (IncidenceBase *, ScheduleMessage::Status status, Method method)
bool acceptRequest (IncidenceBase *, ScheduleMessage::Status status)
bool acceptAdd (IncidenceBase *, ScheduleMessage::Status status)
bool acceptCancel (IncidenceBase *, ScheduleMessage::Status status)
bool acceptDeclineCounter (IncidenceBase *, ScheduleMessage::Status status)
bool acceptReply (IncidenceBase *, ScheduleMessage::Status status, Method method)
bool acceptRefresh (IncidenceBase *, ScheduleMessage::Status status)
bool acceptCounter (IncidenceBase *, ScheduleMessage::Status status)
bool acceptFreeBusy (IncidenceBase *, Method method)

Protected Attributes

CalendarmCalendar
ICalFormatmFormat

Member Enumeration Documentation

iTIP methods.

Definition at line 103 of file scheduler.h.


Constructor & Destructor Documentation

KCal::Scheduler::Scheduler ( Calendar calendar  ) 

Create scheduler for calendar specified as argument.


Member Function Documentation

bool KCal::Scheduler::acceptTransaction ( IncidenceBase ,
Method  method,
ScheduleMessage::Status  status 
)

Accept transaction.

The incidence argument specifies the iCal compoennt on which the transaction acts. The status is the result of processing a iTIP message with the current calendar and specifies the action to be taken for this incidence.

FreeBusyCache* KCal::Scheduler::freeBusyCache (  )  const

Return free/busy cache.

virtual QString KCal::Scheduler::freeBusyDir (  )  [pure virtual]

Returns the directory where the free-busy information is stored.

Implemented in KCal::DummyScheduler.

static QString KCal::Scheduler::methodName ( Method   )  [static]

Return a machine-readable name for a iTIP method.

virtual bool KCal::Scheduler::performTransaction ( IncidenceBase incidence,
Method  method,
const QString &  recipients 
) [pure virtual]

Perform iTIP transaction on incidence to specified recipient(s).

The method is specified as the method argumanet and can be any valid iTIP method.

virtual bool KCal::Scheduler::performTransaction ( IncidenceBase incidence,
Method  method 
) [pure virtual]

Perform iTIP transaction on incidence.

The method is specified as the method argument and can be any valid iTIP method.

virtual bool KCal::Scheduler::publish ( IncidenceBase incidence,
const QString &  recipients 
) [pure virtual]

iTIP publish action

Implemented in KCal::DummyScheduler, and KCal::IMIPScheduler.

virtual QPtrList<ScheduleMessage> KCal::Scheduler::retrieveTransactions (  )  [pure virtual]

Retrieve incoming iTIP transactions.

Implemented in KCal::DummyScheduler, and KCal::IMIPScheduler.

void KCal::Scheduler::setFreeBusyCache ( FreeBusyCache  ) 

Set free/busy cache used to store free/busy information.

static QString KCal::Scheduler::translatedMethodName ( Method   )  [static]

Return a translated human-readable name for a iTIP method.


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys