Storage Plugin

Collaboration diagram for Storage Plugin:

Modules
	CalDAV Storage Plugin
	Provides OpenAB::PIMCalendarItem items using CalDAV protocol (tested with Google Contacts, iCloud).
	CardDAV Storage Plugin
	Provides OpenAB::PIMContactItem items using CardDAV protocol (tested with Google Contacts, iCloud).
	EDS Storage Plugin
	Provides storage for OpenAB::PIMContactItem items using Evolution Data Server.

Detailed Description

Interface: OpenAB_Storage::Storage

Overview

The Storage plugin interface provide all the required functionalities to manage an storage of PIM items.

Storage are extensions of OpenAB::Source that can store items on local storage or in remote databases, all API calls are are synchronous and should block until requested operation finishes.

Generic interface is modeled over Sync Plugin specific requirements, it define a placeholder for all the functionalities required by the Sync Plugins.

Each type of PIMItem (OpenAB::PIMItemType) can define their own interface for accessing Storage providing functions specific to given item type (OpenAB_Storage::ContactsStorage). These interfaces can be used later to receive contents of Storage in more complex manner (eg. using search queries).

API Details

Storage functions

These functions are required to manage the basic Storage operations:

• OpenAB_Storage::Storage::addItem ( Adds a new item (OpenAB::PIMItem) to the Storage. )
• OpenAB_Storage::Storage::removeItem ( Removes item from the Storage. )
• OpenAB_Storage::Storage::modifyItem ( Modifies item (OpenAB::PIMItem) in the Storage. )
• OpenAB_Storage::Storage::getItem ( Get the item from the Storage. )

Additionally versions of above functions that supports batching are required:

• OpenAB_Storage::Storage::addItems ( Adds new items (OpenAB::PIMItem) to the Storage. )
• OpenAB_Storage::Storage::removeItems ( Removes items from the Storage. )
• OpenAB_Storage::Storage::modifyItems ( Modifies items (OpenAB::PIMItem) in the Storage. )
• OpenAB_Storage::Storage::getItems ( Get the items from the Storage. )

These functions are required to manage more complicated Storage tasks, needed mostly during synchronization:

• OpenAB_Storage::Storage::getLatestSyncToken ( If storage supports tracking of items changes, it returns latest status identifier of the storage. )
• OpenAB_Storage::Storage::getRevisions ( OpenAB_Storage::StorageItemIterator ) is used.

This iterator can be generated using the function:

• OpenAB_Storage::Storage::newStorageItemIterator ( Retrieve an new Iterator to quickly parse the list of items. )

The iterator can be parsed using this function:

• OpenAB_Storage::StorageItemIterator::next ( )

It return an OpenAB_Storage::StorageItem will be returned

• OpenAB_Storage::StorageItem ( This object associates OpenAB::PIMItem with its unique ID from OpenAB_Storage::Storage. Additionally it stores status flag used in synchronization process. )

This element can be used to summarize the item using few keywords.

It is mainly used to associate an item to the Storage Unique ID.