com.filenet.bso.api.collaboration.data
Class SubscribeInfo
java.lang.Object
|
+--com.filenet.bso.api.collaboration.data.SubscribeInfo
- All Implemented Interfaces:
- java.io.Serializable
- public class SubscribeInfo
- extends java.lang.Object
- implements java.io.Serializable
The SubscribeInfo
class is a collection of data used to subscribe to teamspace event notifications.
SubscribeInfo objects are parameters to the UserSubscriptionManager method updateSubscriptions
.
- See Also:
UserSubscriptionManager
,
SubscriptionDefinition
,
SubscriptionsStore
, Serialized Form
Constructor Summary |
protected |
SubscribeInfo()
|
|
SubscribeInfo(int subscriptionType,
java.lang.String containerDefID,
java.lang.String subscribedObjID,
java.lang.Integer subscribedObjType)
|
Method Summary |
java.lang.String |
getContainerDefID()
Returns a GUID that specifies the definition ID of the teamspace container object on which the subscription is based. |
java.lang.String |
getSubscribedObjectID()
Returns a GUID that specifies Content Engine object ID referenced by the subscription. |
java.lang.Integer |
getSubscribedObjectType()
Returns an integer that specifies the object type of an Content Engine or Collaboration object referenced by the subscription. |
int |
getSubscriptionType()
Returns an int type that defines the type of subscription. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SubscribeInfo
protected SubscribeInfo()
SubscribeInfo
public SubscribeInfo(int subscriptionType,
java.lang.String containerDefID,
java.lang.String subscribedObjID,
java.lang.Integer subscribedObjType)
getSubscriptionType
public int getSubscriptionType()
- Returns an
int
type that defines the type of subscription.
- Returns:
- An
int
value defining the type of subscription.
getContainerDefID
public java.lang.String getContainerDefID()
- Returns a GUID that specifies the definition ID of the teamspace container object on which the subscription is based.
Depending on the subscription type. May return null, depending
on the subscription type.
- Returns:
- A
String
value that holds the definition ID of a teamspace container.
getSubscribedObjectID
public java.lang.String getSubscribedObjectID()
- Returns a GUID that specifies Content Engine object ID referenced by the subscription.
Depending on the subscription type. May return null, depending
on the subscription type.
- Returns:
- A
String
value that holds a Content Engine object ID.
getSubscribedObjectType
public java.lang.Integer getSubscribedObjectType()
- Returns an integer that specifies the object type of an Content Engine or Collaboration object referenced by the subscription.
- Returns:
- An
int
value that holds a Content Engine or Collaboration object type. May return null, depending
on the subscription type.
Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.