Simias::POBox::POBox Class Reference

A POBox object is a specialized collection used to hold messages. More...

Inheritance diagram for Simias::POBox::POBox:

[legend]

Collaboration diagram for Simias::POBox::POBox:

[legend]

List of all members.

Public Member Functions
	POBox (Store storeObject, string collectionName, string domainName)
	Constructor to create a POBox object.
void	AddMessage (Message message)
	Adds a message to the POBox object.
void	AddMessage (Message[] messageList)
	Adds an array of Message objects to the POBox object.
ICSList	GetMessagesByName (string name)
	Get all the Message objects that have the specified name.
ICSList	GetMessagesByMessageType (string type)
	Get all the Message objects that have the specified type.
Subscription	GetSubscriptionByCollectionID (string collectionID)
	Locates a Subscription in the POBox by CollectionID.
Subscription	GetSubscriptionByCollectionID (string collectionID, string userID)
	Locates a Subscription in the POBox by CollectionID and UserID.
Subscription	CreateSubscription (Collection collection, Member fromMember, string type)
	Creates a Subscription object for the specified collection.
Static Public Member Functions
static POBox	FindPOBox (Store storeObject, string domainId, string userId)
	POBox factory method that constructs a POBox object for the specified user in the specified domain.
static POBox	GetPOBox (Store storeObject, string domainId)
	POBox factory method that constructs a POBox object for the specified domain ID.
static POBox	GetPOBox (Store storeObject, string domainId, string userId)
	POBox factory method that constructs a POBox object for the specified user in the specified domain.
static POBox	GetPOBoxByID (Store store, string id)
	POBox factory method that constructs a POBox object from it's id.
static void	RemoveCollectionBySubscription (string subscription)
	Creates a subscription in the POBox of the ToUser in the Subscription.
static void	RemoveSubscriptionsForCollection (string domainID, string collectionID)
	Removes all subscriptions associated with this collection.
static void	RemoveSubscriptionByMember (string domainID, string collectionID, string userID)
	Removes the subscription for this collection from the specified member.
Public Attributes
const string	POServiceUrlProperty = "POServiceUrl"
	The name of the property storing the DirNode name.
Properties
string	POServiceUrl [get, set]
	Gets/sets the post-office service url.

---

Detailed Description

A POBox object is a specialized collection used to hold messages.

---

Constructor & Destructor Documentation

Simias::POBox::POBox::POBox	(	Store	storeObject,
		string	collectionName,
		string	domainName
	)			[inline]

Constructor to create a POBox object.

Parameters:

	storeObject	The Store object that the POBox will belong to.
	collectionName	The name of the POBox.
	domainName	The name of the domain that the POBox belongs to.

---

Member Function Documentation

static POBox Simias::POBox::POBox::FindPOBox	(	Store	storeObject,
		string	domainId,
		string	userId
	)			[inline, static]

POBox factory method that constructs a POBox object for the specified user in the specified domain.

Parameters:

	storeObject	The Store object that the POBox belongs to.
	domainId	The ID of the domain that the POBox belongs to.
	userId	The ID of the user that the POBox belongs to.

Returns:

static POBox Simias::POBox::POBox::GetPOBox	(	Store	storeObject,
		string	domainId
	)			[inline, static]

POBox factory method that constructs a POBox object for the specified domain ID.

Parameters:

	storeObject	The Store object that the POBox belongs to.
	domainId	The ID of the domain that the POBox belongs to.

Returns:

static POBox Simias::POBox::POBox::GetPOBox	(	Store	storeObject,
		string	domainId,
		string	userId
	)			[inline, static]

POBox factory method that constructs a POBox object for the specified user in the specified domain.

Parameters:

	storeObject	The Store object that the POBox belongs to.
	domainId	The ID of the domain that the POBox belongs to.
	userId	The ID of the user that the POBox belongs to.

Returns:

static POBox Simias::POBox::POBox::GetPOBoxByID	(	Store	store,
		string	id
	)			[inline, static]

POBox factory method that constructs a POBox object from it's id.

Parameters:

	store	The Store object that the POBox belongs to.
	id	The ID of the POBox collection.

Returns:

The POBox object.

void Simias::POBox::POBox::AddMessage

(

Message

message

)

[inline]

Adds a message to the POBox object.

Parameters:

message

The message to add to the collection.

void Simias::POBox::POBox::AddMessage

(

Message[]

messageList

)

[inline]

Adds an array of Message objects to the POBox object.

Parameters:

messageList

An array of Message objects to add to the POBox object.

ICSList Simias::POBox::POBox::GetMessagesByName

(

string

name

)

[inline]

Get all the Message objects that have the specified name.

Parameters:

name

A string containing the name to search for.

Returns:

An ICSList object containing ShallowNode objects that represent the Message object(s) that have the specified name.

ICSList Simias::POBox::POBox::GetMessagesByMessageType

(

string

type

)

[inline]

Get all the Message objects that have the specified type.

Parameters:

type

A string containing the type to search for.

Returns:

An ICSList object containing ShallowNode objects that represent the Message object(s) that have the specified type.

Subscription Simias::POBox::POBox::GetSubscriptionByCollectionID

(

string

collectionID

)

[inline]

Locates a Subscription in the POBox by CollectionID.

Parameters:

collectionID

The ID of the collection.

Returns:

A Subscription object.

Subscription Simias::POBox::POBox::GetSubscriptionByCollectionID	(	string	collectionID,
		string	userID
	)			[inline]

Locates a Subscription in the POBox by CollectionID and UserID.

Parameters:

	collectionID	The ID of the collection.
	userID	The ID of the user to whom the subscription is addressed.

Returns:

A Subscription object.

Subscription Simias::POBox::POBox::CreateSubscription	(	Collection	collection,
		Member	fromMember,
		string	type
	)			[inline]

Creates a Subscription object for the specified collection.

Parameters:

	collection	The Collection object that will be shared.
	fromMember	The Member that is sharing the collection.
	type

Returns:

A Subscription object. This object must be added to the POBox using one of the AddMessage() methods.

static void Simias::POBox::POBox::RemoveCollectionBySubscription

(

string

subscription

)

[inline, static]

Creates a subscription in the POBox of the ToUser in the Subscription.

Parameters:

subscription

Returns:

Removes the collection from the server if the current user is the owner. Otherwise the current user's membership is removed from the collection.

Parameters:

subscription

Subscription to the collection.

static void Simias::POBox::POBox::RemoveSubscriptionsForCollection	(	string	domainID,
		string	collectionID
	)			[inline, static]

Removes all subscriptions associated with this collection.

static void Simias::POBox::POBox::RemoveSubscriptionByMember	(	string	domainID,
		string	collectionID,
		string	userID
	)			[inline, static]

Removes the subscription for this collection from the specified member.

Parameters:

member

Member to remove subscription from.

---

Member Data Documentation

const string Simias::POBox::POBox::POServiceUrlProperty = "POServiceUrl"

The name of the property storing the DirNode name.

---

Property Documentation

string Simias::POBox::POBox::POServiceUrl [get, set]

Gets/sets the post-office service url.

---

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

• src/core/POBox/POBox.cs