pool::ICollection Class Reference

#include <CollectionBase/ICollection.h>

Inheritance diagram for pool::ICollection:

Collaboration diagram for pool::ICollection:

Public Types
enum	OpenMode { CREATE, CREATE_AND_OVERWRITE, UPDATE, READ }
	Enumeration of the possible open modes of the collection. More...

Public Member Functions
virtual ICollection::OpenMode	openMode () const =0
	Returns the open mode of the collection for the present transaction. More...
virtual void	open ()=0
	Opens the collection and initializes it if necessary. More...
virtual bool	isOpen () const =0
	Checks if the collection is open. More...
virtual void	commit (bool restartTransaction=true)=0
	Commits the latest changes made to the collection. More...
virtual void	close ()=0
	Closes the collection and terminates any database connections. More...
virtual const ICollectionDescription &	description () const =0
	Returns an object used to describe the collection properties. More...
virtual ICollectionSchemaEditor &	schemaEditor ()=0
	Returns an object used to modify the collection schema. More...
virtual ICollectionDataEditor &	dataEditor ()=0
	Returns an object used to add, update or delete rows of the collection. More...
virtual ICollectionQuery *	newQuery ()=0
	Returns an object used to query the collection. More...
virtual	~ICollection ()
	Empty destructor. More...

Detailed Description

An interface to a storage technology specific collection of event references and attributes

Definition at line 23 of file ICollection.h.

Member Enumeration Documentation

OpenMode

enum pool::ICollection::OpenMode

Enumeration of the possible open modes of the collection.

Enumerator
CREATE
CREATE_AND_OVERWRITE
UPDATE
READ

Definition at line 27 of file ICollection.h.

{ CREATE, CREATE_AND_OVERWRITE, UPDATE, READ } OpenMode;

Constructor & Destructor Documentation

~ICollection()

virtual pool::ICollection::~ICollection ( )

inlinevirtual

Empty destructor.

Definition at line 57 of file ICollection.h.

{}

Member Function Documentation

close()

virtual void pool::ICollection::close ( )

pure virtual

Closes the collection and terminates any database connections.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

commit()

virtual void pool::ICollection::commit ( bool  restartTransaction = true )

pure virtual

Commits the latest changes made to the collection.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

dataEditor()

virtual ICollectionDataEditor& pool::ICollection::dataEditor ( )

pure virtual

Returns an object used to add, update or delete rows of the collection.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

description()

virtual const ICollectionDescription& pool::ICollection::description ( ) const

pure virtual

Returns an object used to describe the collection properties.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

isOpen()

virtual bool pool::ICollection::isOpen ( ) const

pure virtual

Checks if the collection is open.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

newQuery()

virtual ICollectionQuery* pool::ICollection::newQuery ( )

pure virtual

Returns an object used to query the collection.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

open()

virtual void pool::ICollection::open ( )

pure virtual

Opens the collection and initializes it if necessary.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

openMode()

virtual ICollection::OpenMode pool::ICollection::openMode ( ) const

pure virtual

Returns the open mode of the collection for the present transaction.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

schemaEditor()

virtual ICollectionSchemaEditor& pool::ICollection::schemaEditor ( )

pure virtual

Returns an object used to modify the collection schema.

Implemented in pool::RootCollection::RootCollection, pool::RootCollection::RNTCollection, and pool::ImplicitCollection.

---

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

• ICollection.h