Collaboration API Documentation

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


public interface SubscriptionDefinition

Classes that implement the SubscriptionDefinition define subscriptions to events in a teamspace environment. Using the information in a subscription definition, a subscription object can be created that will cause notifications to be generated when the subscribed event occurs.

See Also:
Teamspace, UserSubscription, UserSubscriptionManager

Method Summary
 java.lang.String getContainerDefinitionID()
          Return the ID of the collaboration container definition, if any, related to the subscription event.
 java.lang.String getDefinitionID()
          Return the ID of the collaboration subscription definition in the Collaboration Store.
 java.lang.String getDescription()
          Return the description of the subscription definition.
 java.lang.String getLabel()
          Return a name label for the subscription definition.
 java.lang.String getSubscribableObjectSymname()
          Return the symbolic name of subscribable object.
 java.lang.Integer getType()
          Return subscription type.
 boolean isContentEngineBased()
          Return true if this subscription is based on a low-level Content Engine subscription; otherwise, return false.
 

Method Detail

getDefinitionID

public java.lang.String getDefinitionID()
Return the ID of the collaboration subscription definition in the Collaboration Store.

Returns:
A String containing the subscription definition ID.

getLabel

public java.lang.String getLabel()
Return a name label for the subscription definition.

Returns:
A String containing the name label.

getDescription

public java.lang.String getDescription()
Return the description of the subscription definition.

Returns:
A String containing the description.

getType

public java.lang.Integer getType()
Return subscription type.

Returns:
An int value.

getSubscribableObjectSymname

public java.lang.String getSubscribableObjectSymname()
Return the symbolic name of subscribable object.

Returns:
A String value.

getContainerDefinitionID

public java.lang.String getContainerDefinitionID()
Return the ID of the collaboration container definition, if any, related to the subscription event.

Returns:
A String containing the container definition ID.

isContentEngineBased

public boolean isContentEngineBased()
Return true if this subscription is based on a low-level Content Engine subscription; otherwise, return false.

Returns:
A boolean value.

Collaboration API Documentation

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