Simias::Storage::NotificationLog Class Reference

Class that represents the notification log collection. More...

Inheritance diagram for Simias::Storage::NotificationLog:

Collaboration diagram for Simias::Storage::NotificationLog:

List of all members.

Public Member Functions

NotificationLog (Store store, ShallowNode shallowNode)

Constructor for creating an existing Notification object from a ShallowNode.

NotificationLog (Collection collection)

Copy constructor for Collection object.

void Clear ()

Clears all entries from the notification log.

void CommitChanges (Node node)

Commits the specified node to the notification log. If any changes have been made to the notification log, these changes are also committed.

void FindCloseEntries (string searchContext)

End the search for notification entries.

bool FindFirstEntries (int count, out string searchContext, out Notification[] notificationList, out int total)

Starts a search for notification entries.

bool FindNextEntries (ref string searchContext, int count, out Notification[] notificationList)

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

bool FindPreviousEntries (ref string searchContext, int count, out Notification[] notificationList)

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

bool FindSeekEntries (ref string searchContext, int offset, int count, out Notification[] notificationList)

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

Static Public Member Functions

static NotificationLog NotificationLogFactory (Store store)

NotificationLog factory method that constructs a NotificationLog object for the specified Store object.

Protected Member Functions

internal NotificationLog (Store store, XmlDocument document)

Constructor for creating an existing NotificationLog object.

Properties

bool LogCollisions [get, set]

Gets/sets a value indicating if collision notifications should be logged.

bool LogMembers [get, set]

Gets/sets a value indicating if member join notifications should be logged.

bool LogQuotaFailures [get, set]

Gets/sets a value indicating if quota sync failure notifications should be logged.

bool LogReadOnlyFailures [get, set]

Gets/sets a value indicating if read-only sync failure notifications should be logged.

bool LogShared [get, set]

Gets/sets a value indicating if collection shared notifications should be logged.

NotificationType NotificationBitMask [get, set]

Gets/sets the notification bitmask for the notification log.

bool PersistByDate [get, set]

Gets/sets a value indicating if the number of notifications persisted is based on the actual number of notifications stored (false) or the number of days the notifications have been stored (true).

int PersistedCount [get, set]

Gets/sets a value indicating the number of notifications stored or the number of days that the notifications are stored (based on the value of PersistByCount.

Detailed Description

Class that represents the notification log collection.

Constructor & Destructor Documentation

Simias::Storage::NotificationLog::NotificationLog	(	Store	store,
		ShallowNode	shallowNode
	)			`[inline]`

Constructor for creating an existing Notification object from a ShallowNode.

Parameters:

	store	Store object that this collection belongs to.
	shallowNode	A ShallowNode object.

Simias::Storage::NotificationLog::NotificationLog ( Collection collection ) [inline]

Copy constructor for Collection object.

Parameters:

collection

Collection object to construct new NotificationLog object from.

internal Simias::Storage::NotificationLog::NotificationLog	(	Store	store,
		XmlDocument	document
	)			`[inline, protected]`

Constructor for creating an existing NotificationLog object.

Parameters:

	store	Store object that this collection belongs to.
	document	Xml document that describes a Notification object.

Member Function Documentation

void Simias::Storage::NotificationLog::Clear ( ) [inline]

Clears all entries from the notification log.

void Simias::Storage::NotificationLog::CommitChanges ( Node node ) [inline]

Commits the specified node to the notification log. If any changes have been made to the notification log, these changes are also committed.

Parameters:

node

The node to commit to the notification log.

void Simias::Storage::NotificationLog::FindCloseEntries ( string searchContext ) [inline]

End the search for notification entries.

Parameters:

searchContext

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

bool Simias::Storage::NotificationLog::FindFirstEntries	(	int	count,
		out string	searchContext,
		out Notification[]	notificationList,
		out int	total
	)			`[inline]`

Starts a search for notification entries.

Parameters:

	count	Maximum number of Notification objects to return.
	searchContext	Receives a provider specific search context object. This object must be serializable.
	notificationList	Receives an array object that contains the Notification objects.
	total	Receives the total number of objects found in the search.

Returns:: True, if there are more notification entries; otherwise, false is returned.

bool Simias::Storage::NotificationLog::FindNextEntries	(	ref string	searchContext,
		int	count,
		out Notification[]	notificationList
	)			`[inline]`

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

Parameters:

	searchContext	Domain provider specific search context returned by FindFirstEntries method.
	count	Maximum number of Notification objects to return.
	notificationList	Receives an array object that contains the Notification objects.

Returns:: True, if there are more notification entries; otherwise, false is returned.

bool Simias::Storage::NotificationLog::FindPreviousEntries	(	ref string	searchContext,
		int	count,
		out Notification[]	notificationList
	)			`[inline]`

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

Parameters:

	searchContext	Domain provider specific search context returned by FindFirstEntries method.
	count	Maximum number of Notification objects to return.
	notificationList	Receives an array object that contains the Notification objects.

Returns:: True, if there are more notification entries; otherwise, false is returned.

bool Simias::Storage::NotificationLog::FindSeekEntries	(	ref string	searchContext,
		int	offset,
		int	count,
		out Notification[]	notificationList
	)			`[inline]`

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

Parameters:

	searchContext	Domain provider specific search context returned by FindFirstEntries method.
	offset	Record offset to return notification entries from.
	count	Maximum number of Notification objects to return.
	notificationList	Receives an array object that contains the Notification objects.

Returns:: True, if there are more notification entries; otherwise, false is returned.

static NotificationLog Simias::Storage::NotificationLog::NotificationLogFactory ( Store store ) [inline, static]

NotificationLog factory method that constructs a NotificationLog object for the specified Store object.

Parameters:

store

Store object.

Returns:: The NotificationLog object for the store.

Property Documentation

bool Simias::Storage::NotificationLog::LogCollisions [get, set]

Gets/sets a value indicating if collision notifications should be logged.

bool Simias::Storage::NotificationLog::LogMembers [get, set]

Gets/sets a value indicating if member join notifications should be logged.

bool Simias::Storage::NotificationLog::LogQuotaFailures [get, set]

Gets/sets a value indicating if quota sync failure notifications should be logged.

bool Simias::Storage::NotificationLog::LogReadOnlyFailures [get, set]

Gets/sets a value indicating if read-only sync failure notifications should be logged.

bool Simias::Storage::NotificationLog::LogShared [get, set]

Gets/sets a value indicating if collection shared notifications should be logged.

NotificationType Simias::Storage::NotificationLog::NotificationBitMask [get, set]

Gets/sets the notification bitmask for the notification log.

bool Simias::Storage::NotificationLog::PersistByDate [get, set]

Gets/sets a value indicating if the number of notifications persisted is based on the actual number of notifications stored (false) or the number of days the notifications have been stored (true).

int Simias::Storage::NotificationLog::PersistedCount [get, set]

Gets/sets a value indicating the number of notifications stored or the number of days that the notifications are stored (based on the value of PersistByCount.

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

src/core/Notifications/Notification.cs


Public Member Functions
	NotificationLog (Store store, ShallowNode shallowNode)
	Constructor for creating an existing Notification object from a ShallowNode.
	NotificationLog (Collection collection)
	Copy constructor for Collection object.
void	Clear ()
	Clears all entries from the notification log.
void	CommitChanges (Node node)
	Commits the specified node to the notification log. If any changes have been made to the notification log, these changes are also committed.
void	FindCloseEntries (string searchContext)
	End the search for notification entries.
bool	FindFirstEntries (int count, out string searchContext, out Notification[] notificationList, out int total)
	Starts a search for notification entries.
bool	FindNextEntries (ref string searchContext, int count, out Notification[] notificationList)
	Continues the search for notification entries from the current record location.
bool	FindPreviousEntries (ref string searchContext, int count, out Notification[] notificationList)
	Continues the search for notification entries previous to the current record location.
bool	FindSeekEntries (ref string searchContext, int offset, int count, out Notification[] notificationList)
	Continues the search for notification entries from the specified record location.
Static Public Member Functions
static NotificationLog	NotificationLogFactory (Store store)
	NotificationLog factory method that constructs a NotificationLog object for the specified Store object.
Protected Member Functions
internal	NotificationLog (Store store, XmlDocument document)
	Constructor for creating an existing NotificationLog object.
Properties
bool	LogCollisions `[get, set]`
	Gets/sets a value indicating if collision notifications should be logged.
bool	LogMembers `[get, set]`
	Gets/sets a value indicating if member join notifications should be logged.
bool	LogQuotaFailures `[get, set]`
	Gets/sets a value indicating if quota sync failure notifications should be logged.
bool	LogReadOnlyFailures `[get, set]`
	Gets/sets a value indicating if read-only sync failure notifications should be logged.
bool	LogShared `[get, set]`
	Gets/sets a value indicating if collection shared notifications should be logged.
NotificationType	NotificationBitMask `[get, set]`
	Gets/sets the notification bitmask for the notification log.
bool	PersistByDate `[get, set]`
	Gets/sets a value indicating if the number of notifications persisted is based on the actual number of notifications stored (false) or the number of days the notifications have been stored (true).
int	PersistedCount `[get, set]`
	Gets/sets a value indicating the number of notifications stored or the number of days that the notifications are stored (based on the value of PersistByCount.