Collaboration API Documentation

com.filenet.bso.api.collaboration.store
Interface SubscriptionsStore


public interface SubscriptionsStore

A class that implements the SubscriptionsStore interface provides access to SubscriptionDefinition objects in the Collaboration Store. These objects define events in the teamspace environment to which a member may be subscribed.

See Also:
SubscriptionDefinition, Teamspace, UserSubscriptionManager

Field Summary
static int CHANGE_IN_TASK_COMPLETION_STATUS_SUBTYPE
          Value of 400; Collaboration subscription type; change in task completion status, completed, expired, reopened.
static int CHANGE_TO_DOCUMENT_SUBTYPE
          Value of 200; Collaboration subscription type; change to document.
static int CHANGE_TO_FOLDER_SUBTYPE
          Value of 300; Collaboration subscription type; change to folder.
static int DOCUMENT_ADDED_TO_FOLDER_SUBTYPE
          Value of 301; Collaboration subscription type; a document added to a specific folder.
static int FOLDER_ADDED_TO_FOLDER_SUBTYPE
          Value of 302; Collaboration subscription type; a folder added to a specific folder.
static java.lang.String OWNER_TEAMSPACE_PROP_SYMNAME
          Value of "Teamspace"; Content Engine property name.
static int REPLY_POSTED_TO_TOPIC_SUBTYPE
          Value of 101; Collaboration subscription type; reply posted to a topic.
static java.lang.String SUBSCRIBERS_PROP_SYMNAME
          Value of "Subscribers"; Content Engine property name.
static java.lang.String SUBSCRIPTION_CONTAINER_SYMNAME
          Value of "CollaborationUserSubscription"; symbolic class name for Content Engine user subscription object.
static java.lang.String SUBSCRIPTIONOBJECTID_PROP_SYMNAME
          Value of "SubscriptionObjectID"; Content Engine property name.
static java.lang.String SUBSCRIPTIONOBJECTTYPE_PROP_SYMNAME
          Value of "SubscriptionObjectType"; Content Engine property name.
static java.lang.String SUBSCRIPTIONTARGETID_PROP_SYMNAME
          Value of "LinkObjectID"; Content Engine property name.
static java.lang.String SUBSCRIPTIONTARGETTYPE_PROP_SYMNAME
          Value of "LinkObjectType"; Content Engine property name.
static java.lang.String SUBSCRIPTIONTYPE_PROP_SYMNAME
          Value of "SubscriptionType"; Content Engine property name.
static int TASK_COMPLETED_SUBTYPE
          Value of 401; Collaboration subscription type; task completed.
static int TASK_EXPIRED_SUBTYPE
          Value of 403; Collaboration subscription type; task expired.
static int TASK_REOPENED_SUBTYPE
          Value of 402; Collaboration subscription type; task reopened.
static int TOPIC_ADDED_TO_FORUM_SUBTYPE
          Value of 100; Collaboration subscription type; topic added to a forum.
 
Method Summary
 SubscriptionDefinition getSubscriptionDefinitionByID(java.lang.String subscriptionDefinitionID)
          Return a SubscriptionDefinition object from the Collaboration Store based on the unique subscription definition id.
 SubscriptionDefinition getSubscriptionDefinitionByType(int subscriptionType)
          Return a SubscriptionDefinition object from the Collaboration Store based on the unique subscription type.
 java.util.Iterator getSubscriptionDefinitions()
          Return an iterator over the collection of SubscriptionDefinition objects in the Collaboration Store.
 java.lang.String getSubscriptionDefinitionsXML()
          Return an XML string containing all SubscriptionDefinition objects in the Collaboration Store.
 

Field Detail

TOPIC_ADDED_TO_FORUM_SUBTYPE

public static final int TOPIC_ADDED_TO_FORUM_SUBTYPE
Value of 100; Collaboration subscription type; topic added to a forum.

REPLY_POSTED_TO_TOPIC_SUBTYPE

public static final int REPLY_POSTED_TO_TOPIC_SUBTYPE
Value of 101; Collaboration subscription type; reply posted to a topic.

CHANGE_TO_DOCUMENT_SUBTYPE

public static final int CHANGE_TO_DOCUMENT_SUBTYPE
Value of 200; Collaboration subscription type; change to document.

CHANGE_TO_FOLDER_SUBTYPE

public static final int CHANGE_TO_FOLDER_SUBTYPE
Value of 300; Collaboration subscription type; change to folder.

DOCUMENT_ADDED_TO_FOLDER_SUBTYPE

public static final int DOCUMENT_ADDED_TO_FOLDER_SUBTYPE
Value of 301; Collaboration subscription type; a document added to a specific folder.

FOLDER_ADDED_TO_FOLDER_SUBTYPE

public static final int FOLDER_ADDED_TO_FOLDER_SUBTYPE
Value of 302; Collaboration subscription type; a folder added to a specific folder.

CHANGE_IN_TASK_COMPLETION_STATUS_SUBTYPE

public static final int CHANGE_IN_TASK_COMPLETION_STATUS_SUBTYPE
Value of 400; Collaboration subscription type; change in task completion status, completed, expired, reopened.

TASK_COMPLETED_SUBTYPE

public static final int TASK_COMPLETED_SUBTYPE
Value of 401; Collaboration subscription type; task completed.

TASK_REOPENED_SUBTYPE

public static final int TASK_REOPENED_SUBTYPE
Value of 402; Collaboration subscription type; task reopened.

TASK_EXPIRED_SUBTYPE

public static final int TASK_EXPIRED_SUBTYPE
Value of 403; Collaboration subscription type; task expired.

SUBSCRIPTION_CONTAINER_SYMNAME

public static final java.lang.String SUBSCRIPTION_CONTAINER_SYMNAME
Value of "CollaborationUserSubscription"; symbolic class name for Content Engine user subscription object.

SUBSCRIBERS_PROP_SYMNAME

public static final java.lang.String SUBSCRIBERS_PROP_SYMNAME
Value of "Subscribers"; Content Engine property name.

OWNER_TEAMSPACE_PROP_SYMNAME

public static final java.lang.String OWNER_TEAMSPACE_PROP_SYMNAME
Value of "Teamspace"; Content Engine property name.

SUBSCRIPTIONOBJECTID_PROP_SYMNAME

public static final java.lang.String SUBSCRIPTIONOBJECTID_PROP_SYMNAME
Value of "SubscriptionObjectID"; Content Engine property name.

SUBSCRIPTIONOBJECTTYPE_PROP_SYMNAME

public static final java.lang.String SUBSCRIPTIONOBJECTTYPE_PROP_SYMNAME
Value of "SubscriptionObjectType"; Content Engine property name.

SUBSCRIPTIONTYPE_PROP_SYMNAME

public static final java.lang.String SUBSCRIPTIONTYPE_PROP_SYMNAME
Value of "SubscriptionType"; Content Engine property name.

SUBSCRIPTIONTARGETID_PROP_SYMNAME

public static final java.lang.String SUBSCRIPTIONTARGETID_PROP_SYMNAME
Value of "LinkObjectID"; Content Engine property name.

SUBSCRIPTIONTARGETTYPE_PROP_SYMNAME

public static final java.lang.String SUBSCRIPTIONTARGETTYPE_PROP_SYMNAME
Value of "LinkObjectType"; Content Engine property name.
Method Detail

getSubscriptionDefinitionByID

public SubscriptionDefinition getSubscriptionDefinitionByID(java.lang.String subscriptionDefinitionID)
Return a SubscriptionDefinition object from the Collaboration Store based on the unique subscription definition id.

Parameters:
subscriptionDefinitionID - The id of the subscription definition.

Returns:
A SubscriptionDefinition object.

getSubscriptionDefinitionByType

public SubscriptionDefinition getSubscriptionDefinitionByType(int subscriptionType)
Return a SubscriptionDefinition object from the Collaboration Store based on the unique subscription type.

Parameters:
subscriptionType - The type value of the subscription definition.

Returns:
A SubscriptionDefinition object.

getSubscriptionDefinitions

public java.util.Iterator getSubscriptionDefinitions()
Return an iterator over the collection of SubscriptionDefinition objects in the Collaboration Store.

Returns:
An iterator over a collection of SubscriptionDefinition objects.

getSubscriptionDefinitionsXML

public java.lang.String getSubscriptionDefinitionsXML()
Return an XML string containing all SubscriptionDefinition objects in the Collaboration Store.

Returns:
An XML String.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.