ODateBookAccessBackend Class Reference

This class is the interface to the storage of Events. More...

#include <odatebookaccessbackend.h>

Inheritance diagram for ODateBookAccessBackend:

[legend]Collaboration diagram for ODateBookAccessBackend:


Public Types
typedef int	UID
Public Member Functions
	ODateBookAccessBackend ()
	c'tor without parameter
	~ODateBookAccessBackend ()
virtual QArray< UID >	rawEvents () const=0
	This method should return a list of UIDs containing all events.
virtual QArray< UID >	rawRepeats () const=0
	This method should return a list of UIDs containing all repeating events.
virtual QArray< UID >	nonRepeats () const=0
	This mthod should return a list of UIDs containing all non repeating events.
virtual OEvent::ValueList	directNonRepeats ()=0
	If you do not want to implement the effectiveEvents methods below you need to supply it with directNonRepeats.
virtual OEvent::ValueList	directRawRepeats ()=0
	Same as above but return raw repeats!
virtual OEffectiveEvent::ValueList	effectiveEvents (const QDate &from, const QDate &to)
	Effective Events are special event occuring during a time frame.
virtual OEffectiveEvent::ValueList	effectiveEvents (const QDateTime &start)
	this is an overloaded member function
virtual OEffectiveEvent::ValueList	effectiveNonRepeatingEvents (const QDate &from, const QDate &to)
	Effective Events are special event occuring during a time frame.
virtual OEffectiveEvent::ValueList	effectiveNonRepeatingEvents (const QDateTime &start)
	this is an overloaded member function

Detailed Description

This class is the interface to the storage of Events.

See also:: OPimAccessBackend

Definition at line 14 of file odatebookaccessbackend.h.

Member Typedef Documentation

typedef int ODateBookAccessBackend::UID

Definition at line 16 of file odatebookaccessbackend.h.

Constructor & Destructor Documentation

ODateBookAccessBackend::ODateBookAccessBackend ( )

c'tor without parameter

Definition at line 122 of file odatebookaccessbackend.cpp.

ODateBookAccessBackend::~ODateBookAccessBackend ( )

Definition at line 127 of file odatebookaccessbackend.cpp.

Member Function Documentation

virtual QArray<UID> ODateBookAccessBackend::rawEvents ( ) const [pure virtual]

This method should return a list of UIDs containing all events.
No filter should be applied
Returns:
list of events

Implemented in ODateBookAccessBackend_SQL, and ODateBookAccessBackend_XML.

virtual QArray<UID> ODateBookAccessBackend::rawRepeats ( ) const [pure virtual]

This method should return a list of UIDs containing all repeating events.
No filter should be applied
Returns:
list of repeating events

Implemented in ODateBookAccessBackend_SQL, and ODateBookAccessBackend_XML.

virtual QArray<UID> ODateBookAccessBackend::nonRepeats ( ) const [pure virtual]

This mthod should return a list of UIDs containing all non repeating events.
No filter should be applied
Returns:
list of nonrepeating events

Implemented in ODateBookAccessBackend_SQL, and ODateBookAccessBackend_XML.

virtual OEvent::ValueList ODateBookAccessBackend::directNonRepeats ( ) [pure virtual]

If you do not want to implement the effectiveEvents methods below you need to supply it with directNonRepeats.
This method can return empty lists if effectiveEvents is implememted
Implemented in ODateBookAccessBackend_SQL, and ODateBookAccessBackend_XML.
Referenced by effectiveEvents(), and effectiveNonRepeatingEvents().

virtual OEvent::ValueList ODateBookAccessBackend::directRawRepeats ( ) [pure virtual]

Same as above but return raw repeats!

Implemented in ODateBookAccessBackend_SQL, and ODateBookAccessBackend_XML.
Referenced by effectiveEvents().

OEffectiveEvent::ValueList ODateBookAccessBackend::effectiveEvents ( const QDate & from,

const QDate & to

) [virtual]

Effective Events are special event occuring during a time frame.
This method does calcualte EffectiveEvents bases on the directNonRepeats and directRawRepeats. You may implement this method yourself
Definition at line 130 of file odatebookaccessbackend.cpp.
References directNonRepeats(), directRawRepeats(), events(), repeat(), OEvent::ValueList, and OEffectiveEvent::ValueList.
Referenced by effectiveEvents(), and ODateBookAccess::effectiveEvents().

OEffectiveEvent::ValueList ODateBookAccessBackend::effectiveEvents ( const QDateTime & start ) [virtual]

this is an overloaded member function

See also:
effectiveEvents( const QDate& from, const QDate& to )

Definition at line 143 of file odatebookaccessbackend.cpp.
References QValueList::append(), QValueList::begin(), QDateTime::date(), effectiveEvents(), QValueList::end(), QDateTime::secsTo(), and OEffectiveEvent::ValueList.

OEffectiveEvent::ValueList ODateBookAccessBackend::effectiveNonRepeatingEvents ( const QDate & from,

const QDate & to

) [virtual]

Effective Events are special event occuring during a time frame.
This method does calcualte EffectiveEvents bases on the directNonRepeats and directRawRepeats. You may implement this method yourself
Definition at line 158 of file odatebookaccessbackend.cpp.
References directNonRepeats(), events(), OEvent::ValueList, and OEffectiveEvent::ValueList.
Referenced by effectiveNonRepeatingEvents(), and ODateBookAccess::effectiveNonRepeatingEvents().

OEffectiveEvent::ValueList ODateBookAccessBackend::effectiveNonRepeatingEvents ( const QDateTime & start ) [virtual]

this is an overloaded member function

See also:
effectiveNonRepeatingEvents( const QDate& from, const QDate& to )

Definition at line 169 of file odatebookaccessbackend.cpp.
References QValueList::append(), QValueList::begin(), QDateTime::date(), effectiveNonRepeatingEvents(), QValueList::end(), QDateTime::secsTo(), and OEffectiveEvent::ValueList.

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

libopie PIM API Documentation

ODateBookAccessBackend Class Reference

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation