Simias::Storage::Provider::IProvider Interface Reference

Collection Store Provider interface. More...

Inheritance diagram for Simias::Storage::Provider::IProvider:

[legend]

List of all members.

Public Member Functions
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 container)
	Called to get 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.

---

Detailed Description

Collection Store Provider interface.

---

Member Function Documentation

void Simias::Storage::Provider::IProvider::CreateStore

(

)

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

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

void Simias::Storage::Provider::IProvider::DeleteStore

(

)

Called to Delete the opened CollectionStore.

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

void Simias::Storage::Provider::IProvider::OpenStore

(

)

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

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

void Simias::Storage::Provider::IProvider::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.

Parameters:

name

The name of the container.

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

void Simias::Storage::Provider::IProvider::DeleteContainer

(

string

name

)

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

Parameters:

name

The name of the container.

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

void Simias::Storage::Provider::IProvider::CommitRecords	(	string	container,
		XmlDocument	createDoc,
		XmlDocument	deleteDoc
	)

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.

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

XmlDocument Simias::Storage::Provider::IProvider::GetRecord	(	string	recordId,
		string	container
	)

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

Parameters:

	recordId	string that contains the ID of the Record to retrieve
	container	The container that holds the record.

Returns:

XMLDocument describing the Record

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

XmlDocument Simias::Storage::Provider::IProvider::GetShallowRecord

(

string

recordId

)

Called to get a shallow record.

Parameters:

recordId

The record id to get.

Returns:

XmlDocument describing the shallow Record.

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

IResultSet Simias::Storage::Provider::IProvider::Search

(

Query

query

)

Method used to search for Records using the specified query.

Parameters:

query

Query used for this search

Returns:

Implemented in Simias::Storage::Provider::Flaim::FlaimProvider.

---

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

• src/core/StoreProvider/IProvider.cs