Simias::Storage::Journal Class Reference

Collaboration diagram for Simias::Storage::Journal:

[legend]

List of all members.

Public Member Functions
	Journal (string collectionID)
	Constructs a Journal object.
void	Commit ()
	Commit the changes made to the journal.
void	FindCloseEntries (string searchContext)
	End the search for journal entries.
bool	FindFirstEntries (string fileID, string userID, int count, out string searchContext, out JournalEntry[] journalList, out int total)
	Starts a search for journal entries.
bool	FindFirstEntries (string fileID, string userID, DateTime fromTime, DateTime toTime, int count, out string searchContext, out JournalEntry[] journalList, out int total)
	Starts a search for journal entries.
bool	FindNextEntries (ref string searchContext, int count, out JournalEntry[] journalList)
	Continues the search for journal entries from the current record location.
bool	FindPreviousEntries (ref string searchContext, int count, out JournalEntry[] journalList)
	Continues the search for journal entries previous to the current record location.
bool	FindSeekEntries (ref string searchContext, uint offset, int count, out JournalEntry[] journalList)
	Continues the search for journal entries from the specified record location.
bool	GetSeekEntries (string fileID, string userID, DateTime fromTime, DateTime toTime, int count, uint offset, out JournalEntry[] journalList, out int total)
	Retrieves all journal entries from the specified offset.
bool	GetSeekEntries (string fileID, string userID, int count, uint offset, out JournalEntry[] journalList, out int total)
	Retrieves all journal entries from the specified offset.
void	UpdateJournal (NodeEventArgs args)
	Update the journal.

---

Detailed Description

---

Constructor & Destructor Documentation

Simias::Storage::Journal::Journal

(

string

collectionID

)

[inline]

Constructs a Journal object.

Parameters:

collectionID

The identifier of the collection that this Journal object belongs to.

---

Member Function Documentation

void Simias::Storage::Journal::Commit

(

)

[inline]

Commit the changes made to the journal.

void Simias::Storage::Journal::FindCloseEntries

(

string

searchContext

)

[inline]

End the search for journal entries.

Parameters:

searchContext

Domain provider specific search context returned by FindFirstJournalEntries or FindNextEntries methods.

bool Simias::Storage::Journal::FindFirstEntries	(	string	fileID,
		string	userID,
		int	count,
		out string	searchContext,
		out JournalEntry[]	journalList,
		out int	total
	)			[inline]

Starts a search for journal entries.

Parameters:

	fileID	The fileID to filter on. Only journal entries with this fileID will be returned. Pass in null to retrieve journal entries regardless of fileID.
	userID	The UserID to filter on. Only journal entries with this userID will be returned. Pass in null to retrieve journal entries regardless of userID.
	count	Maximum number of JournalEntry objects to return. Pass in zero to return all entries.
	searchContext	Receives a provider specific search context object. This object must be serializable.
	journalList	Receives an array object that contains the JournalEntry objects.
	total	Receives the total number of objects found in the search.

Returns:

True if there are more journal entries. Otherwise false is returned.

bool Simias::Storage::Journal::FindFirstEntries	(	string	fileID,
		string	userID,
		DateTime	fromTime,
		DateTime	toTime,
		int	count,
		out string	searchContext,
		out JournalEntry[]	journalList,
		out int	total
	)			[inline]

Starts a search for journal entries.

Parameters:

	fileID	The fileID to filter on. Only journal entries with this fileID will be returned. Pass in null to retrieve journal entries regardless of fileID.
	userID	The UserID to filter on. Only journal entries with this userID will be returned. Pass in null to retrieve journal entries regardless of userID.
	fromTime	The minimum time to filter on. Any journal entries that have occurred since this time will be returned.
	toTime	The maximum time to filter on. Any journal entries that occurred before this time will be returned.
	count	Maximum number of JournalEntry objects to return. Pass in zero to return all entries.
	searchContext	Receives a provider specific search context object. This object must be serializable.
	journalList	Receives an array object that contains the JournalEntry objects.
	total	Receives the total number of objects found in the search.

Returns:

True if there are more journal entries. Otherwise false is returned.

bool Simias::Storage::Journal::FindNextEntries	(	ref string	searchContext,
		int	count,
		out JournalEntry[]	journalList
	)			[inline]

Continues the search for journal entries from the current record location.

Parameters:

	searchContext	Domain provider specific search context returned by FindFirstJournalEntries method.
	count	Maximum number of JournalEntry objects to return. Pass in zero to return all entries.
	journalList	Receives an array object that contains the JournalEntry objects.

Returns:

True if there are more journal entries. Otherwise false is returned.

bool Simias::Storage::Journal::FindPreviousEntries	(	ref string	searchContext,
		int	count,
		out JournalEntry[]	journalList
	)			[inline]

Continues the search for journal entries previous to the current record location.

Parameters:

	searchContext	Domain provider specific search context returned by FindFirstJournalEntries method.
	count	Maximum number of JournalEntry objects to return. Pass in zero to return all entries.
	journalList	Receives an array object that contains the JournalEntry objects.

Returns:

True if there are more journal entries. Otherwise false is returned.

bool Simias::Storage::Journal::FindSeekEntries	(	ref string	searchContext,
		uint	offset,
		int	count,
		out JournalEntry[]	journalList
	)			[inline]

Continues the search for journal entries from the specified record location.

Parameters:

	searchContext	Domain provider specific search context returned by FindFirstJournalEntries method.
	offset	Record offset to return journal entries from.
	count	Maximum number of JournalEntry objects to return. Pass in zero to return all entries.
	journalList	Receives an array object that contains the JournalEntry objects.

Returns:

True if there are more journal entries. Otherwise false is returned.

bool Simias::Storage::Journal::GetSeekEntries	(	string	fileID,
		string	userID,
		DateTime	fromTime,
		DateTime	toTime,
		int	count,
		uint	offset,
		out JournalEntry[]	journalList,
		out int	total
	)			[inline]

Retrieves all journal entries from the specified offset.

Parameters:

	fileID	The fileID to filter on. Only journal entries with this fileID will be returned. Pass in null to retrieve journal entries regardless of fileID.
	userID	The UserID to filter on. Only journal entries with this userID will be returned. Pass in null to retrieve journal entries regardless of userID.
	fromTime	The minimum time to filter on. Any journal entries that have occurred since this time will be returned.
	toTime	The maximum time to filter on. Any journal entries that occurred before this time will be returned.
	count	Maximum number of JournalEntry objects to return. Pass in zero to return all entries.
	offset	Record offset to return journal entries from.
	journalList	Receives an array object that contains the JournalEntry objects.
	total	Receives the total number of objects found in the search.

Returns:

True if there are more journal entries; otherwise, false is returned.

bool Simias::Storage::Journal::GetSeekEntries	(	string	fileID,
		string	userID,
		int	count,
		uint	offset,
		out JournalEntry[]	journalList,
		out int	total
	)			[inline]

Retrieves all journal entries from the specified offset.

Parameters:

	fileID	The fileID to filter on. Only journal entries with this fileID will be returned. Pass in null to retrieve journal entries regardless of fileID.
	userID	The UserID to filter on. Only journal entries with this userID will be returned. Pass in null to retrieve journal entries regardless of userID.
	count	Maximum number of JournalEntry objects to return. Pass in zero to return all entries.
	offset	Record offset to return journal entries from.
	journalList	Receives an array object that contains the JournalEntry objects.
	total	Receives the total number of objects found in the search.

Returns:

True if there are more journal entries; otherwise, false is returned.

void Simias::Storage::Journal::UpdateJournal

(

NodeEventArgs

args

)

[inline]

Update the journal.

Parameters:

args

Contains the information to put in the journal.

---

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

• src/core/Journal/Journal.cs