OpenAB  1.0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
OpenAB::PIMCalendarItem Class Referenceabstract

Documentation for class PIMCalendarItem. More...

#include <PIMCalendarItem.hpp>

Inheritance diagram for OpenAB::PIMCalendarItem:
Collaboration diagram for OpenAB::PIMCalendarItem:

Public Member Functions

 PIMCalendarItem (PIMItemType t)
 Constructor. More...
 
virtual ~PIMCalendarItem ()=0
 Destructor, virtual by default. More...
 
bool parse (const std::string &iCalendar)
 Parses item from string. Format of string to be parsed from depends on type of item. More...
 
SmartPtr< PIMItemIndexgetIndex ()
 Returns index for given item. More...
 
std::string getRawData () const
 Returns raw data of item. Format of raw data depends on type of item. More...
 
- Public Member Functions inherited from OpenAB::PIMItem
 PIMItem (PIMItemType t)
 Constructor. More...
 
virtual ~PIMItem ()
 Destructor, virtual by default. More...
 
virtual ID getId () const
 Returns Source/Storage specific id of item. Can be empty, as not all Sources/Storages provides id of items. More...
 
virtual void setId (const ID &id, bool replace=false)
 Sets id of item. More...
 
virtual Revision getRevision () const
 Returns Source/Storage specific revision of item. Can be empty, as not all Sources/Storages provides revision of items. More...
 
virtual void setRevision (const Revision &rev)
 Sets revision of item. More...
 
PIMItemType getType () const
 Returns type of item. More...
 
- Public Member Functions inherited from OpenAB::KeyValueItem
 KeyValueItem ()
 default constructor More...
 
virtual ~KeyValueItem ()
 
bool parse (const std::string &rawData)
 parses item from raw data string More...
 
std::map< std::string,
std::vector< ItemField > > & 
getFields ()
 Returns all fields of item. More...
 

Additional Inherited Members

- Public Types inherited from OpenAB::PIMItem
typedef std::string ID
 
typedef std::string Revision
 
typedef std::vector
< OpenAB::PIMItem::ID
IDs
 
typedef std::vector
< OpenAB::PIMItem::Revision
Revisions
 
- Protected Member Functions inherited from OpenAB::KeyValueItem
virtual bool processField ()
 Handler that processed contents of given fields. Can be override in child classes. More...
 
- Protected Attributes inherited from OpenAB::PIMItem
PIMItemType type
 
ID id
 
Revision revision
 
- Protected Attributes inherited from OpenAB::KeyValueItem
std::string currentLine
 
std::string currentFieldName
 
std::string currentFieldValue
 
std::string currentFieldValueOriginal
 
std::map< std::string,
std::vector< ItemField > > 
fields
 
std::map< std::string,
std::vector< SmartPtr
< KeyValueItem > > > 
subcomponents
 

Detailed Description

Documentation for class PIMCalendarItem.

Constructor & Destructor Documentation

OpenAB::PIMCalendarItem::PIMCalendarItem ( PIMItemType  t)

Constructor.

OpenAB::PIMCalendarItem::~PIMCalendarItem ( )
pure virtual

Destructor, virtual by default.

Member Function Documentation

SmartPtr< PIMItemIndex > OpenAB::PIMCalendarItem::getIndex ( )
virtual

Returns index for given item.

Returns
index for given item.

Implements OpenAB::PIMItem.

std::string OpenAB::PIMCalendarItem::getRawData ( ) const
virtual

Returns raw data of item. Format of raw data depends on type of item.

Returns
raw data of item

Implements OpenAB::PIMItem.

bool OpenAB::PIMCalendarItem::parse ( const std::string &  raw)
virtual

Parses item from string. Format of string to be parsed from depends on type of item.

Note
during parsing new fields (not defined by standard format from which item is being parsed) can be added to improve matching and comparison of items. For more details see documentation of classes implementing PIMItem interface.
Parameters
[in]rawraw data to be parsed.
Returns
true if item was parsed successfully, false otherwise.

Implements OpenAB::PIMItem.


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