Simias::Storage::Provider::Flaim::FlaimProvider Class Reference

Class that implements the Novell.iFolder.Storage.Provider.IProvider interface using the FAIM record manager. More...

Inheritance diagram for Simias::Storage::Provider::Flaim::FlaimProvider:

Collaboration diagram for Simias::Storage::Provider::Flaim::FlaimProvider:

List of all members.

Public Member Functions

FlaimProvider (ProviderConfig conf)

Constructs a flaim provider.

void CreateStore ()

Called to Create a new Collection Store at the specified location.

void DeleteStore ()

Called to Delete the opened CollectionStore.

void OpenStore ()

Called to Open an existing Collection store at the specified location.

void CreateContainer (string name)

Called to create a container to hold records. This call does not need to be made. If a record is created and the container does not exist. it will be created.

void DeleteContainer (string name)

Called to Delete a record container. This call is deep (all records contained are deleted).

void CommitRecords (string container, XmlDocument createDoc, XmlDocument deleteDoc)

Used to Create, Modify or Delete records from the store.

XmlDocument GetRecord (string recordId, string collectionId)

Called to ge a Record. The record is returned as an XML string representation.

XmlDocument GetShallowRecord (string recordId)

Called to get a shallow record.

IResultSet Search (Query query)

Method used to search for Records using the specified query.

void Dispose ()

Method used to cleanup unmanaged resources.

Detailed Description

Class that implements the Novell.iFolder.Storage.Provider.IProvider interface using the FAIM record manager.

Constructor & Destructor Documentation

Simias::Storage::Provider::Flaim::FlaimProvider::FlaimProvider ( ProviderConfig conf ) [inline]

Constructs a flaim provider.

Parameters:

conf

The config object for this provider.

Member Function Documentation

void Simias::Storage::Provider::Flaim::FlaimProvider::CreateStore ( ) [inline]

Called to Create a new Collection Store at the specified location.

Implements Simias::Storage::Provider::IProvider.

void Simias::Storage::Provider::Flaim::FlaimProvider::DeleteStore ( ) [inline]

Called to Delete the opened CollectionStore.

Implements Simias::Storage::Provider::IProvider.

void Simias::Storage::Provider::Flaim::FlaimProvider::OpenStore ( ) [inline]

Called to Open an existing Collection store at the specified location.

Implements Simias::Storage::Provider::IProvider.

void Simias::Storage::Provider::Flaim::FlaimProvider::CreateContainer ( string name ) [inline]

Called to create a container to hold records. This call does not need to be made. If a record is created and the container does not exist. it will be created.

Parameters:

name

The name of the container.

Implements Simias::Storage::Provider::IProvider.

void Simias::Storage::Provider::Flaim::FlaimProvider::DeleteContainer ( string name ) [inline]

Called to Delete a record container. This call is deep (all records contained are deleted).

Parameters:

name

The name of the container.

Implements Simias::Storage::Provider::IProvider.

void Simias::Storage::Provider::Flaim::FlaimProvider::CommitRecords	(	string	container,
		XmlDocument	createDoc,
		XmlDocument	deleteDoc
	)			`[inline]`

Used to Create, Modify or Delete records from the store.

Parameters:

	container	The container that the commit applies to.
	createDoc	The records to create or modify.
	deleteDoc	The records to delete.

Implements Simias::Storage::Provider::IProvider.

XmlDocument Simias::Storage::Provider::Flaim::FlaimProvider::GetRecord	(	string	recordId,
		string	collectionId
	)			`[inline]`

Called to ge a Record. The record is returned as an XML string representation.

Parameters:

	recordId	string that contains the ID of the Record to retrieve
	collectionId	The id of the collection that contains this Record.

Returns:: XML string describing the Record

Implements Simias::Storage::Provider::IProvider.

XmlDocument Simias::Storage::Provider::Flaim::FlaimProvider::GetShallowRecord ( string recordId ) [inline]

Called to get a shallow record.

Parameters:

recordId

The record id to get.

Returns:: XmlDocument describing the shallow Record.

Implements Simias::Storage::Provider::IProvider.

IResultSet Simias::Storage::Provider::Flaim::FlaimProvider::Search ( Query query ) [inline]

Method used to search for Records using the specified query.

Parameters:

query

Query used for this search

Returns:

Implements Simias::Storage::Provider::IProvider.

void Simias::Storage::Provider::Flaim::FlaimProvider::Dispose ( ) [inline]

Method used to cleanup unmanaged resources.

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

src/core/FlaimProvider/FlaimProvider.cs


Public Member Functions
	FlaimProvider (ProviderConfig conf)
	Constructs a flaim provider.
void	CreateStore ()
	Called to Create a new Collection Store at the specified location.
void	DeleteStore ()
	Called to Delete the opened CollectionStore.
void	OpenStore ()
	Called to Open an existing Collection store at the specified location.
void	CreateContainer (string name)
	Called to create a container to hold records. This call does not need to be made. If a record is created and the container does not exist. it will be created.
void	DeleteContainer (string name)
	Called to Delete a record container. This call is deep (all records contained are deleted).
void	CommitRecords (string container, XmlDocument createDoc, XmlDocument deleteDoc)
	Used to Create, Modify or Delete records from the store.
XmlDocument	GetRecord (string recordId, string collectionId)
	Called to ge a Record. The record is returned as an XML string representation.
XmlDocument	GetShallowRecord (string recordId)
	Called to get a shallow record.
IResultSet	Search (Query query)
	Method used to search for Records using the specified query.
void	Dispose ()
	Method used to cleanup unmanaged resources.