libkcal

KCal::Scheduler

KCal::Scheduler Class Reference

This class provides an encapsulation of iTIP transactions. More...

#include <scheduler.h>

Inheritance diagram for KCal::Scheduler:

Inheritance graph
[legend]

List of all members.


Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

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

Protected Attributes

Calendar * mCalendar
ICalFormat * mFormat

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.

Member Enumeration Documentation

enum KCal::Scheduler::Method

iTIP methods.

Enumerator:
Publish 
Request 
Refresh 
Cancel 
Add 
Reply 
Counter 
Declinecounter 
NoMethod 

Definition at line 103 of file scheduler.h.

Constructor & Destructor Documentation

Scheduler::Scheduler ( Calendar *  calendar  ) 

Create scheduler for calendar specified as argument.

Definition at line 71 of file scheduler.cpp.

Scheduler::~Scheduler (  )  [virtual]

Definition at line 80 of file scheduler.cpp.

Member Function Documentation

bool Scheduler::acceptAdd ( IncidenceBase *  incidence,
ScheduleMessage::Status  status 
) [protected]

Definition at line 249 of file scheduler.cpp.

bool Scheduler::acceptCancel ( IncidenceBase *  incidence,
ScheduleMessage::Status  status 
) [protected]

Definition at line 255 of file scheduler.cpp.

bool Scheduler::acceptCounter ( IncidenceBase *  incidence,
ScheduleMessage::Status  status 
) [protected]

Definition at line 414 of file scheduler.cpp.

bool Scheduler::acceptDeclineCounter ( IncidenceBase *  incidence,
ScheduleMessage::Status  status 
) [protected]

Definition at line 276 of file scheduler.cpp.

bool Scheduler::acceptFreeBusy ( IncidenceBase *  incidence,
Method  method 
) [protected]

Definition at line 420 of file scheduler.cpp.

bool Scheduler::acceptPublish ( IncidenceBase *  newIncBase,
ScheduleMessage::Status  status,
Method  method 
) [protected]

Definition at line 179 of file scheduler.cpp.

bool Scheduler::acceptRefresh ( IncidenceBase *  incidence,
ScheduleMessage::Status  status 
) [protected]

Definition at line 407 of file scheduler.cpp.

bool Scheduler::acceptReply ( IncidenceBase *  incidence,
ScheduleMessage::Status  status,
Method  method 
) [protected]

Definition at line 288 of file scheduler.cpp.

bool Scheduler::acceptRequest ( IncidenceBase *  newIncBase,
ScheduleMessage::Status  status 
) [protected]

Definition at line 217 of file scheduler.cpp.

bool Scheduler::acceptTransaction ( IncidenceBase *  incidence,
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.

Definition at line 97 of file scheduler.cpp.

bool Scheduler::deleteTransaction ( IncidenceBase *  incidence  )  [virtual]

Definition at line 174 of file scheduler.cpp.

FreeBusyCache * Scheduler::freeBusyCache (  )  const

Return free/busy cache.

Definition at line 92 of file scheduler.cpp.

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

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

Implemented in KCal::DummyScheduler.

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

Return a machine-readable name for a iTIP method.

Definition at line 126 of file scheduler.cpp.

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.

Implemented in KCal::DummyScheduler.

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.

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

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 Scheduler::setFreeBusyCache ( FreeBusyCache *  c  ) 

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

Definition at line 87 of file scheduler.cpp.

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

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

Definition at line 150 of file scheduler.cpp.

Member Data Documentation

Calendar* KCal::Scheduler::mCalendar [protected]

Definition at line 183 of file scheduler.h.

ICalFormat* KCal::Scheduler::mFormat [protected]

Definition at line 184 of file scheduler.h.

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