Simias::Server::Catalog Class Reference

Class to manage the creation, deletion and querying of a global collection catalog that is replicated across all simias servers within a simias system. More...

Collaboration diagram for Simias::Server::Catalog:

[legend]

List of all members.

Static Public Member Functions
static void	AddCollectionForMovement (string collectionID, bool status)
	Adds the collection into MovingCollection hashtable.
static void	RemoveCollectionForMovement (string collectionID)
	remove the collectionID from hashtable
static string[]	GetAllCollectionIDsByUserID (string UserID)
	Method to retrieve all collection IDs the specified user is a member of.
static string[]	GetAllEntryIDsByUserID (string UserID)
	Method to retrieve all catalog entry IDs the specified user is a member of.
static CatalogEntry[]	GetAllEntriesByUserID (string UserID)
	Method to retrieve all catalog entries the specified user is a member of.
static CatalogEntry[]	GetAllEntriesByName (string name, SearchOp searchOp)
	Get all the entries in the catalogue.
static CatalogEntry	GetEntryByCollectionID (string CollectionID)
	Get a catalog entry for the specified collection.
static void	SetHostForCollection (string collectionID, string hostID)
	set the hostid property for this collection
static void	DeleteEntryByCollectionID (string CollectionID)
	Delete a catalog entry for the specified collection.

---

Detailed Description

Class to manage the creation, deletion and querying of a global collection catalog that is replicated across all simias servers within a simias system.

---

Member Function Documentation

static void Simias::Server::Catalog::AddCollectionForMovement	(	string	collectionID,
		bool	status
	)			[inline, static]

Adds the collection into MovingCollection hashtable.

Parameters:

	collectionID	collection id
	status	not used inthis function

static void Simias::Server::Catalog::RemoveCollectionForMovement

(

string

collectionID

)

[inline, static]

remove the collectionID from hashtable

Parameters:

collectionID

static string [] Simias::Server::Catalog::GetAllCollectionIDsByUserID

(

string

UserID

)

[inline, static]

Method to retrieve all collection IDs the specified user is a member of.

Parameters:

UserID

userid sought for

Returns:

string array containing ids of collection

static string [] Simias::Server::Catalog::GetAllEntryIDsByUserID

(

string

UserID

)

[inline, static]

Method to retrieve all catalog entry IDs the specified user is a member of.

Parameters:

UserID

userid

Returns:

catalog entryIDs for this userid

static CatalogEntry [] Simias::Server::Catalog::GetAllEntriesByUserID

(

string

UserID

)

[inline, static]

Method to retrieve all catalog entries the specified user is a member of.

Parameters:

UserID

userid

Returns:

catalog entry arrray for this userid

static CatalogEntry [] Simias::Server::Catalog::GetAllEntriesByName	(	string	name,
		SearchOp	searchOp
	)			[inline, static]

Get all the entries in the catalogue.

Parameters:

	name	entryname
	searchOp	search operation e.g. equals,contains etc

Returns:

catalog entry array

static CatalogEntry Simias::Server::Catalog::GetEntryByCollectionID

(

string

CollectionID

)

[inline, static]

Get a catalog entry for the specified collection.

Returns:

catalog entry

static void Simias::Server::Catalog::SetHostForCollection	(	string	collectionID,
		string	hostID
	)			[inline, static]

set the hostid property for this collection

Parameters:

	collectionID	collection id
	hostID	host id to set

static void Simias::Server::Catalog::DeleteEntryByCollectionID

(

string

CollectionID

)

[inline, static]

Delete a catalog entry for the specified collection.

---

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

• src/server/Simias.Server/Catalog.cs