com.filenet.bso.api.collaboration
Interface UserSubscriptionManager
- public interface UserSubscriptionManager
A class that implements the UserSubscriptionManager
interface provides functionality that enables members
to subscribe to teamspace event notifications, and return information about current subscriptions.
- See Also:
SubscriptionDefinition
,
SubscriptionsStore
,
SubscribeInfo
,
UnsubscribeInfo
Method Summary |
java.lang.String |
getObjectSubscriptionsXML(int objType,
java.lang.String objId)
Returns an XML string containing all potential user subscriptions for this object within a teamspace,
along with subscription indicators for the current user. |
java.util.Iterator |
getSubscriptions()
Return an iterator over a collection of UserSubscription objects representing subscriptions
for the current user within the current teamspace. |
void |
updateSubscriptions(SubscribeInfo[] subscribeInfo,
UnsubscribeInfo[] unsubscribeInfo)
Update subscriptions for a teamspace. |
updateSubscriptions
public void updateSubscriptions(SubscribeInfo[] subscribeInfo,
UnsubscribeInfo[] unsubscribeInfo)
throws ValidationException
- Update subscriptions for a teamspace. Takes arrays of subscriptions to create and/or remove.
- Parameters:
subscribeInfo
- An array of SubscribeInfo objects that describe subscriptions to create. May be null.
unsubscribeInfo
- An array of UnsubscribeInfo objects that describe subscriptions to be removed. May be null.
getSubscriptions
public java.util.Iterator getSubscriptions()
- Return an iterator over a collection of
UserSubscription
objects representing subscriptions
for the current user within the current teamspace.
- Returns:
- A collection of
UserSubscription
objects.
- See Also:
UserSubscription
getObjectSubscriptionsXML
public java.lang.String getObjectSubscriptionsXML(int objType,
java.lang.String objId)
- Returns an XML string containing all potential user subscriptions for this object within a teamspace,
along with subscription indicators for the current user.
- Parameters:
objType
- The type of object (either the Content Engine object type or the Collaboration object type). Required.
objId
- The GUID of the object. Required.
- Returns:
- A XML
String
.
Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.