com.filenet.api.events
Interface Subscription

All Superinterfaces:
ActionConsumer, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable
All Known Subinterfaces:
ClassSubscription, ClassWorkflowSubscription, InstanceSubscription, InstanceWorkflowSubscription

public interface Subscription
extends RepositoryObject, ActionConsumer

Represents a request to execute an event action when an event is triggered on a target Content Engine object. For example, you can have a subscription that notifies you by email when documents of a certain class are created and saved in the object store. The specified EventAction and Subscribable objects, which represent the event action and target object, must exist before you can create a Subscription object and persist it.

Subscription is the base class for subclasses defined with specialized behavior. You can create objects for the subclasses, but you cannot create a base Subscription object. You can, however, instantiate one in the following ways:

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: true
StorageType: ObjectStore
SuperclassName: ActionConsumer


Method Summary
 void changeClass(java.lang.String className)
          Changes the class of a Content Engine object.
 EventAction get_EventAction()
          Returns the value of the EventAction property.
 java.lang.String get_FilteredPropertyId()
          Returns the value of the FilteredPropertyId property.
 java.lang.String get_FilterExpression()
          Returns the value of the FilterExpression property.
 java.lang.Boolean get_IsEnabled()
          Returns the value of the IsEnabled property.
 java.lang.Boolean get_IsSynchronous()
          Returns the value of the IsSynchronous property.
 SubscribedEventList get_SubscribedEvents()
          Returns the value of the SubscribedEvents property.
 Subscribable get_SubscriptionTarget()
          Returns the value of the SubscriptionTarget property.
 java.lang.String get_UserString()
          Returns the value of the UserString property.
 void set_EventAction(EventAction value)
          Sets the value of the EventAction property.
 void set_FilteredPropertyId(java.lang.String value)
          Sets the value of the FilteredPropertyId property.
 void set_FilterExpression(java.lang.String value)
          Sets the value of the FilterExpression property.
 void set_IsEnabled(java.lang.Boolean value)
          Sets the value of the IsEnabled property.
 void set_IsSynchronous(java.lang.Boolean value)
          Sets the value of the IsSynchronous property.
 void set_SubscribedEvents(SubscribedEventList value)
          Sets the value of the SubscribedEvents property.
 void set_SubscriptionTarget(Subscribable value)
          Sets the value of the SubscriptionTarget property.
 void set_UserString(java.lang.String value)
          Sets the value of the UserString property.
 
Methods inherited from interface com.filenet.api.events.ActionConsumer
get_ActiveMarkings, get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_Id, get_LastModifier, get_Name, get_Owner, get_Permissions, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_LastModifier, set_Owner, set_Permissions
 
Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
 
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_EventAction

EventAction get_EventAction()
Returns the value of the EventAction property. For more information, see EventAction Property.


set_EventAction

void set_EventAction(EventAction value)
Sets the value of the EventAction property. For more information, see EventAction Property.


get_SubscriptionTarget

Subscribable get_SubscriptionTarget()
Returns the value of the SubscriptionTarget property. For more information, see SubscriptionTarget Property.


set_SubscriptionTarget

void set_SubscriptionTarget(Subscribable value)
Sets the value of the SubscriptionTarget property. For more information, see SubscriptionTarget Property.


get_IsEnabled

java.lang.Boolean get_IsEnabled()
Returns the value of the IsEnabled property. For more information, see IsEnabled Property.


set_IsEnabled

void set_IsEnabled(java.lang.Boolean value)
Sets the value of the IsEnabled property. For more information, see IsEnabled Property.


get_IsSynchronous

java.lang.Boolean get_IsSynchronous()
Returns the value of the IsSynchronous property. For more information, see IsSynchronous Property.


set_IsSynchronous

void set_IsSynchronous(java.lang.Boolean value)
Sets the value of the IsSynchronous property. For more information, see IsSynchronous Property.


get_FilterExpression

java.lang.String get_FilterExpression()
Returns the value of the FilterExpression property. For more information, see FilterExpression Property.


set_FilterExpression

void set_FilterExpression(java.lang.String value)
Sets the value of the FilterExpression property. For more information, see FilterExpression Property.


get_FilteredPropertyId

java.lang.String get_FilteredPropertyId()
Returns the value of the FilteredPropertyId property. For more information, see FilteredPropertyId Property.


set_FilteredPropertyId

void set_FilteredPropertyId(java.lang.String value)
Sets the value of the FilteredPropertyId property. For more information, see FilteredPropertyId Property.


get_UserString

java.lang.String get_UserString()
Returns the value of the UserString property. For more information, see UserString Property.


set_UserString

void set_UserString(java.lang.String value)
Sets the value of the UserString property. For more information, see UserString Property.


get_SubscribedEvents

SubscribedEventList get_SubscribedEvents()
Returns the value of the SubscribedEvents property. For more information, see SubscribedEvents Property.


set_SubscribedEvents

void set_SubscribedEvents(SubscribedEventList value)
Sets the value of the SubscribedEvents property. For more information, see SubscribedEvents Property.


changeClass

void changeClass(java.lang.String className)
Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The changeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:

When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:

Parameters:
className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.
Throws:
E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.


© Copyright IBM Corporation 2006, 2008. All rights reserved.