Simias::Storage::NotificationSearchState Class Reference

Class used to keep track of outstanding searches. More...

Collaboration diagram for Simias::Storage::NotificationSearchState:

[legend]

List of all members.

Public Member Functions
	NotificationSearchState (string collectionID, ICSEnumerator enumerator, int totalRecords)
	Initializes an instance of an object.
void	Dispose ()
	Allows for quick release of managed and unmanaged resources. Called by applications.
Static Public Member Functions
static NotificationSearchState	GetSearchState (string contextHandle)
	Returns a search context object that contains the state information for an outstanding search.
Properties
bool	IsDisposed [get]
	Indicates if the object has been disposed.
string	ContextHandle [get]
	Gets the context handle for this object.
int	CurrentRecord [get, set]
	Gets or sets the current record.
string	CollectionID [get]
	Gets the ID for the collection that is being searched.
int	LastCount [get, set]
	Gets or sets the last record count.
ICSEnumerator	Enumerator [get]
	Gets the search iterator.
int	TotalRecords [get]
	Gets the total number of records contained by this search.

---

Detailed Description

Class used to keep track of outstanding searches.

---

Constructor & Destructor Documentation

Simias::Storage::NotificationSearchState::NotificationSearchState	(	string	collectionID,
		ICSEnumerator	enumerator,
		int	totalRecords
	)			[inline]

Initializes an instance of an object.

Parameters:

	collectionID	Identifier for the collection that is being searched.
	enumerator	Search iterator.
	totalRecords	The total number of records contained in the search.

---

Member Function Documentation

static NotificationSearchState Simias::Storage::NotificationSearchState::GetSearchState

(

string

contextHandle

)

[inline, static]

Returns a search context object that contains the state information for an outstanding search.

Parameters:

contextHandle

Context handle that refers to a specific search context object.

Returns:

A SearchState object if a valid one exists, otherwise a null is returned.

void Simias::Storage::NotificationSearchState::Dispose

(

)

[inline]

Allows for quick release of managed and unmanaged resources. Called by applications.

---

Property Documentation

bool Simias::Storage::NotificationSearchState::IsDisposed [get]

Indicates if the object has been disposed.

string Simias::Storage::NotificationSearchState::ContextHandle [get]

Gets the context handle for this object.

int Simias::Storage::NotificationSearchState::CurrentRecord [get, set]

Gets or sets the current record.

string Simias::Storage::NotificationSearchState::CollectionID [get]

Gets the ID for the collection that is being searched.

int Simias::Storage::NotificationSearchState::LastCount [get, set]

Gets or sets the last record count.

ICSEnumerator Simias::Storage::NotificationSearchState::Enumerator [get]

Gets the search iterator.

int Simias::Storage::NotificationSearchState::TotalRecords [get]

Gets the total number of records contained by this search.

---

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

• src/core/Notifications/Notification.cs