|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISCSDocumentSubscriptionAPI
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 |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAPIObjectFactory getObjectFactory()
ISCSSubscriptionContentItemsResponse getContentForSubscription(ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) throws CommandException
SCSContext
- the context object representing the current usersubscriptionID
- the subscription ID
CommandException
ISCSSubscriptionContentItemsResponse getContentForSubscription(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usersubscriptionID
- the subscription ID
CommandException
ISCSSubscribeResponse subscribe(ISCSContext SCSContext, ISCSSubscription subscription, ISCSContentID contentID) throws CommandException
SCSContext
- the context object representing the current usersubscription
- the populated subscription objectcontentID
- the content ID of the content item to subscribe
CommandException
ISCSSubscribeResponse subscribe(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscription subscription, ISCSContentID contentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usersubscription
- the populated subscription objectcontentID
- the content ID of the content item to subscribe
CommandException
ISCSSubscribeResponse subscribe(ISCSContext SCSContext, ISCSSubscription subscription, java.util.List criteria) throws CommandException
SCSContext
- the context object representing the current usersubscription
- the populated subscription objectcriteria
- a list of strings denoting the criteria that corresponds with the requirements of the subscription type
CommandException
ISCSSubscribeResponse subscribe(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscription subscription, java.util.List criteria) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usersubscription
- the populated subscription objectcriteria
- a list of strings denoting the criteria that corresponds with the requirements of the subscription type
CommandException
ISCSSubscriptionContentListResponse getContentSubscribers(ISCSContext SCSContext, ISCSContentID contentID) throws CommandException
SCSContext
- the context object representing the current usercontentID
- the content ID to use to query for subscriptions
CommandException
ISCSSubscriptionContentListResponse getContentSubscribers(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContentID contentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usercontentID
- the content ID to use to query for subscriptions
CommandException
ISCSSubscriptionContentListResponse getContentSubscribers(ISCSContext SCSContext, ISCSContent content) throws CommandException
SCSContext
- the context object representing the current usercontent
- the content item to query
CommandException
ISCSSubscriptionContentListResponse getContentSubscribers(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usercontent
- the content item to query
CommandException
ISCSSubscriptionUserListResponse getSubscriptionsForUser(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSSubscriptionUserListResponse getSubscriptionsForUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSUnsubscribeResponse unsubscribe(ISCSContext SCSContext, ISCSSubscriptionID subscriptionID, java.lang.String userName) throws CommandException
SCSContext
- the context object representing the current usersubscriptionID
- the subscription IDuserName
- the user ID
CommandException
ISCSUnsubscribeResponse unsubscribe(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscriptionID subscriptionID, java.lang.String userName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usersubscriptionID
- the subscription IDuserName
- the user ID
CommandException
ISCSUnsubscribeResponse unsubscribe(ISCSContext SCSContext, ISCSSubscription subscription) throws CommandException
SCSContext
- the context object representing the current usersubscription
- the populated subscription object
CommandException
ISCSUnsubscribeResponse unsubscribe(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscription subscription) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usersubscription
- the populated subscription object
CommandException
ISCSUnsubscribeResponse unsubscribeAll(ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) throws CommandException
SCSContext
- the context object representing the current usersubscriptionID
- the subscription ID
CommandException
ISCSUnsubscribeResponse unsubscribeAll(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usersubscriptionID
- the subscription ID
CommandException
ISCSSubscriptionNotifyUpdateResponse updateAndNotifySubscription(ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) throws CommandException
SCSContext
- the context object representing the current usersubscriptionID
- the subscription ID
CommandException
ISCSSubscriptionNotifyUpdateResponse updateAndNotifySubscription(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSubscriptionID subscriptionID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usersubscriptionID
- the subscription ID
CommandException
ISCSSubscription _createSubscription()
ISCSSubscriptionBasicID _createBasicSubscriptionID(java.lang.String contentID)
contentID
- the ID of the content this subscription represents
ISCSSubscriptionCriteriaID _createCriteriaSubscriptionID(java.util.List criteriaList, java.lang.String subscriptionType)
subscriptionType
- the type of criteria subscriptioncriteriaList
- a list of Strings containing the subscription criteria
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |