com.stellent.cis.client.api.scs.document.subscription
Interface ISCSDocumentSubscriptionAPI

All Superinterfaces:

ICommandAPI

public interface ISCSDocumentSubscriptionAPI
extends ICommandAPI

The command API implementation of the document.subscription commands. This implementation can be accessed directly via the ICommandFacade class, using the API name document.subscription, with the following syntax:

 ISCSDocumentSubscriptionAPI commandAPI =
       (ISCSDocumentSubscriptionAPI)m_commandFacade.getCommandAPI ("document.subscription", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSSubscriptionBasicID	_createBasicSubscriptionID(java.lang.String contentID) Create a subscription ID.
ISCSSubscriptionCriteriaID	_createCriteriaSubscriptionID(java.util.List criteriaList, java.lang.String subscriptionType) Create a subscription criteria ID.
ISCSSubscription	_createSubscription() Create a new empty subscription object.
ISCSSubscriptionContentItemsResponse	getContentForSubscription(ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) List the documents matching a given subscription
ISCSSubscriptionContentItemsResponse	getContentForSubscription(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) List the documents matching a given subscription
ISCSSubscriptionContentListResponse	getContentSubscribers(ISCSContext SCSContext, ISCSContent content) Retrieve a list of subscribers for a given content item or content item ID.
ISCSSubscriptionContentListResponse	getContentSubscribers(ISCSContext SCSContext, ISCSContentID contentID) Retrieve a list of subscribers for a given content item or content item ID.
ISCSSubscriptionContentListResponse	getContentSubscribers(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content) Retrieve a list of subscribers for a given content item or content item ID.
ISCSSubscriptionContentListResponse	getContentSubscribers(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID) Retrieve a list of subscribers for a given content item or content item ID.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSSubscriptionUserListResponse	getSubscriptionsForUser(ISCSContext SCSContext) Returns a list of all subscribed content items for the current user
ISCSSubscriptionUserListResponse	getSubscriptionsForUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Returns a list of all subscribed content items for the current user
ISCSSubscribeResponse	subscribe(ISCSContext SCSContext, ISCSSubscription subscription, ISCSContentID contentID) Subscribe to a content item.
ISCSSubscribeResponse	subscribe(ISCSContext SCSContext, ISCSSubscription subscription, java.util.List criteria) Subscribe to a content item.
ISCSSubscribeResponse	subscribe(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscription subscription, ISCSContentID contentID) Subscribe to a content item.
ISCSSubscribeResponse	subscribe(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscription subscription, java.util.List criteria) Subscribe to a content item.
ISCSUnsubscribeResponse	unsubscribe(ISCSContext SCSContext, ISCSSubscription subscription) Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.
ISCSUnsubscribeResponse	unsubscribe(ISCSContext SCSContext, ISCSSubscriptionID subscriptionID, java.lang.String userName) Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.
ISCSUnsubscribeResponse	unsubscribe(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscription subscription) Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.
ISCSUnsubscribeResponse	unsubscribe(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscriptionID subscriptionID, java.lang.String userName) Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.
ISCSUnsubscribeResponse	unsubscribeAll(ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.
ISCSUnsubscribeResponse	unsubscribeAll(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.
ISCSSubscriptionNotifyUpdateResponse	updateAndNotifySubscription(ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) Updates the current subscription notification field and sends an unsubscribe notification
ISCSSubscriptionNotifyUpdateResponse	updateAndNotifySubscription(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) Updates the current subscription notification field and sends an unsubscribe notification

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()

Retrieve the object factory associated with this API

getContentForSubscription

ISCSSubscriptionContentItemsResponse getContentForSubscription(ISCSContext SCSContext,
                                                               ISCSSubscriptionID subscriptionID)
                                                               throws CommandException

List the documents matching a given subscription

Parameters:

SCSContext - the context object representing the current user

subscriptionID - the subscription ID

Throws:

CommandException

See Also:

"Content Server Documentation for: DOC_SUBS_LIST"

getContentForSubscription

ISCSSubscriptionContentItemsResponse getContentForSubscription(ISCSRequestModifier requestModifier,
                                                               ISCSContext SCSContext,
                                                               ISCSSubscriptionID subscriptionID)
                                                               throws CommandException

List the documents matching a given subscription

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

subscriptionID - the subscription ID

Throws:

CommandException

See Also:

"Content Server Documentation for: DOC_SUBS_LIST"

subscribe

ISCSSubscribeResponse subscribe(ISCSContext SCSContext,
                                ISCSSubscription subscription,
                                ISCSContentID contentID)
                                throws CommandException

Subscribe to a content item.

Parameters:

SCSContext - the context object representing the current user

subscription - the populated subscription object

contentID - the content ID of the content item to subscribe

Throws:

CommandException

See Also:

"Content Server Documentation for: SUBSCRIBE_EX"

subscribe

ISCSSubscribeResponse subscribe(ISCSRequestModifier requestModifier,
                                ISCSContext SCSContext,
                                ISCSSubscription subscription,
                                ISCSContentID contentID)
                                throws CommandException

Subscribe to a content item.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

subscription - the populated subscription object

contentID - the content ID of the content item to subscribe

Throws:

CommandException

See Also:

"Content Server Documentation for: SUBSCRIBE_EX"

subscribe

ISCSSubscribeResponse subscribe(ISCSContext SCSContext,
                                ISCSSubscription subscription,
                                java.util.List criteria)
                                throws CommandException

Subscribe to a content item.

Parameters:

SCSContext - the context object representing the current user

subscription - the populated subscription object

criteria - a list of strings denoting the criteria that corresponds with the requirements of the subscription type

Throws:

CommandException

See Also:

"Content Server Documentation for: SUBSCRIBE_EX"

subscribe

ISCSSubscribeResponse subscribe(ISCSRequestModifier requestModifier,
                                ISCSContext SCSContext,
                                ISCSSubscription subscription,
                                java.util.List criteria)
                                throws CommandException

Subscribe to a content item.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

subscription - the populated subscription object

criteria - a list of strings denoting the criteria that corresponds with the requirements of the subscription type

Throws:

CommandException

See Also:

"Content Server Documentation for: SUBSCRIBE_EX"

getContentSubscribers

ISCSSubscriptionContentListResponse getContentSubscribers(ISCSContext SCSContext,
                                                          ISCSContentID contentID)
                                                          throws CommandException

Retrieve a list of subscribers for a given content item or content item ID.

Parameters:

SCSContext - the context object representing the current user

contentID - the content ID to use to query for subscriptions

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DOC_SUBSCRIBERS"

getContentSubscribers

ISCSSubscriptionContentListResponse getContentSubscribers(ISCSRequestModifier requestModifier,
                                                          ISCSContext SCSContext,
                                                          ISCSContentID contentID)
                                                          throws CommandException

Retrieve a list of subscribers for a given content item or content item ID.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

contentID - the content ID to use to query for subscriptions

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DOC_SUBSCRIBERS"

getContentSubscribers

ISCSSubscriptionContentListResponse getContentSubscribers(ISCSContext SCSContext,
                                                          ISCSContent content)
                                                          throws CommandException

Retrieve a list of subscribers for a given content item or content item ID.

Parameters:

SCSContext - the context object representing the current user

content - the content item to query

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DOC_SUBSCRIBERS"

getContentSubscribers

ISCSSubscriptionContentListResponse getContentSubscribers(ISCSRequestModifier requestModifier,
                                                          ISCSContext SCSContext,
                                                          ISCSContent content)
                                                          throws CommandException

Retrieve a list of subscribers for a given content item or content item ID.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

content - the content item to query

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DOC_SUBSCRIBERS"

getSubscriptionsForUser

ISCSSubscriptionUserListResponse getSubscriptionsForUser(ISCSContext SCSContext)
                                                         throws CommandException

Returns a list of all subscribed content items for the current user

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: SUBSCRIPTION_LIST"

getSubscriptionsForUser

ISCSSubscriptionUserListResponse getSubscriptionsForUser(ISCSRequestModifier requestModifier,
                                                         ISCSContext SCSContext)
                                                         throws CommandException

Returns a list of all subscribed content items for the current user

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: SUBSCRIPTION_LIST"

unsubscribe

ISCSUnsubscribeResponse unsubscribe(ISCSContext SCSContext,
                                    ISCSSubscriptionID subscriptionID,
                                    java.lang.String userName)
                                    throws CommandException

Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.

Parameters:

SCSContext - the context object representing the current user

subscriptionID - the subscription ID

userName - the user ID

Throws:

CommandException

See Also:

"Content Server Documentation for: UNSUBSCRIBE_FROM_LIST_EX"

unsubscribe

ISCSUnsubscribeResponse unsubscribe(ISCSRequestModifier requestModifier,
                                    ISCSContext SCSContext,
                                    ISCSSubscriptionID subscriptionID,
                                    java.lang.String userName)
                                    throws CommandException

Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

subscriptionID - the subscription ID

userName - the user ID

Throws:

CommandException

See Also:

"Content Server Documentation for: UNSUBSCRIBE_FROM_LIST_EX"

unsubscribe

ISCSUnsubscribeResponse unsubscribe(ISCSContext SCSContext,
                                    ISCSSubscription subscription)
                                    throws CommandException

Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.

Parameters:

SCSContext - the context object representing the current user

subscription - the populated subscription object

Throws:

CommandException

See Also:

"Content Server Documentation for: UNSUBSCRIBE_FROM_LIST_EX"

unsubscribe

ISCSUnsubscribeResponse unsubscribe(ISCSRequestModifier requestModifier,
                                    ISCSContext SCSContext,
                                    ISCSSubscription subscription)
                                    throws CommandException

Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

subscription - the populated subscription object

Throws:

CommandException

See Also:

"Content Server Documentation for: UNSUBSCRIBE_FROM_LIST_EX"

unsubscribeAll

ISCSUnsubscribeResponse unsubscribeAll(ISCSContext SCSContext,
                                       ISCSSubscriptionID subscriptionID)
                                       throws CommandException

Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.

Parameters:

SCSContext - the context object representing the current user

subscriptionID - the subscription ID

Throws:

CommandException

See Also:

"Content Server Documentation for: UNSUBSCRIBE_FROM_LIST_EX"

unsubscribeAll

ISCSUnsubscribeResponse unsubscribeAll(ISCSRequestModifier requestModifier,
                                       ISCSContext SCSContext,
                                       ISCSSubscriptionID subscriptionID)
                                       throws CommandException

Cancels a content item subscription for a user or for all users matching the subscription if no user ID is specified.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

subscriptionID - the subscription ID

Throws:

CommandException

See Also:

"Content Server Documentation for: UNSUBSCRIBE_FROM_LIST_EX"

updateAndNotifySubscription

ISCSSubscriptionNotifyUpdateResponse updateAndNotifySubscription(ISCSContext SCSContext,
                                                                 ISCSSubscriptionID subscriptionID)
                                                                 throws CommandException

Updates the current subscription notification field and sends an unsubscribe notification

Parameters:

SCSContext - the context object representing the current user

subscriptionID - the subscription ID

Throws:

CommandException

See Also:

"Content Server Documentation for: UPDATE_SUBSCRIPTION_NOTIFY"

updateAndNotifySubscription

ISCSSubscriptionNotifyUpdateResponse updateAndNotifySubscription(ISCSRequestModifier requestModifier,
                                                                 ISCSContext SCSContext,
                                                                 ISCSSubscriptionID subscriptionID)
                                                                 throws CommandException

Updates the current subscription notification field and sends an unsubscribe notification

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

subscriptionID - the subscription ID

Throws:

CommandException

See Also:

"Content Server Documentation for: UPDATE_SUBSCRIPTION_NOTIFY"

_createSubscription

ISCSSubscription _createSubscription()

Create a new empty subscription object.

Returns:

a new empty subscription object

_createBasicSubscriptionID

ISCSSubscriptionBasicID _createBasicSubscriptionID(java.lang.String contentID)

Create a subscription ID.

Parameters:

contentID - the ID of the content this subscription represents

Returns:

a subscription ID

_createCriteriaSubscriptionID

ISCSSubscriptionCriteriaID _createCriteriaSubscriptionID(java.util.List criteriaList,
                                                         java.lang.String subscriptionType)

Create a subscription criteria ID.

Parameters:

subscriptionType - the type of criteria subscription

criteriaList - a list of Strings containing the subscription criteria

Returns:

a subscription ID