com.filenet.api.events

Interface DocumentState

All Superinterfaces:

DependentObject, EngineObject, RepositoryObject, java.io.Serializable

public interface DocumentState
extends RepositoryObject, EngineObject, DependentObject

Represents a valid lifecycle state of a document lifecycle policy. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken and which access permissions to be applied when a document's lifecycle state changes. To define the lifecycle states in a document lifecycle policy, create a DocumentState object for each lifecycle state that you want to define and add it to a DocumentLifecyclePolicy object's DocumentStates collection.

Each lifecycle state must have a name, which is set by the StateName property. Each lifecycle state name must be unique within the lifecycle policy in which it is defined. To specify whether a given lifecycle state can be demoted or not, set its CanBeDemoted property.

The order of the lifecycle states in a document lifecycle policy's DocumentStates collection is important and determines the succession of lifecycle states. When a document that is associated with a document lifecycle policy is created, its initial lifecycle state is the first DocumentState object in the document lifecycle policy's DocumentStates collection. To move a document into the next lifecycle state defined in the document lifecycle policy's DocumentStates collection, call the document's changeState method and set its flags parameter to the LifecycleChangeFlags.PROMOTE constant. To move a document into the previous lifecycle state (unless the document's current lifecycle state's CanBeDemoted property is set to false), set the method's flags parameter to DEMOTE.

The template permissions specified by the TemplatePermissions property will be applied during a lifecycle state change if you set the ApplyTemplatePermissions property to true; otherwise the permissions will not be applied. If the ApplyTemplatePermissions property to set to true and you reset a document's lifecycle state, either by calling its changeState method and specifying RESET or by calling its checkin method while the ResetLifecycleOnCheckin property on its document lifecycle policy is set to true, the access permissions will be reset to the access permissions of the initial lifecycle state.

Metadata

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

See Also:

DocumentLifecyclePolicy

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	get_ApplyTemplatePermissions() Returns the value of the ApplyTemplatePermissions property.
java.lang.Boolean	get_CanBeDemoted() Returns the value of the CanBeDemoted property.
Id	get_Id() Returns the value of the Id property.
java.lang.String	get_Name() Returns the value of the Name property.
java.lang.String	get_StateName() Returns the value of the StateName property.
AccessPermissionDescriptionList	get_TemplatePermissionDescriptions() Returns the value of the TemplatePermissionDescriptions property.
AccessPermissionList	get_TemplatePermissions() Returns the value of the TemplatePermissions property.
void	set_ApplyTemplatePermissions(java.lang.Boolean value) Sets the value of the ApplyTemplatePermissions property.
void	set_CanBeDemoted(java.lang.Boolean value) Sets the value of the CanBeDemoted property.
void	set_StateName(java.lang.String value) Sets the value of the StateName property.
void	set_TemplatePermissions(AccessPermissionList value) Sets the value of the TemplatePermissions property.

Methods inherited from interface com.filenet.api.core.RepositoryObject

getObjectStore

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_StateName

java.lang.String get_StateName()

Returns the value of the StateName property. For more information, see StateName Property.

set_StateName

void set_StateName(java.lang.String value)

Sets the value of the StateName property. For more information, see StateName Property.

get_CanBeDemoted

java.lang.Boolean get_CanBeDemoted()

Returns the value of the CanBeDemoted property. For more information, see CanBeDemoted Property.

set_CanBeDemoted

void set_CanBeDemoted(java.lang.Boolean value)

Sets the value of the CanBeDemoted property. For more information, see CanBeDemoted Property.

get_Id

Id get_Id()

Returns the value of the Id property. For more information, see Id Property.

get_Name

java.lang.String get_Name()

Returns the value of the Name property. For more information, see Name Property.

get_ApplyTemplatePermissions

java.lang.Boolean get_ApplyTemplatePermissions()

Returns the value of the ApplyTemplatePermissions property. For more information, see ApplyTemplatePermissions Property.

set_ApplyTemplatePermissions

void set_ApplyTemplatePermissions(java.lang.Boolean value)

Sets the value of the ApplyTemplatePermissions property. For more information, see ApplyTemplatePermissions Property.

get_TemplatePermissions

AccessPermissionList get_TemplatePermissions()

Returns the value of the TemplatePermissions property. For more information, see TemplatePermissions Property.

set_TemplatePermissions

void set_TemplatePermissions(AccessPermissionList value)

Sets the value of the TemplatePermissions property. For more information, see TemplatePermissions Property.

get_TemplatePermissionDescriptions

AccessPermissionDescriptionList get_TemplatePermissionDescriptions()

Returns the value of the TemplatePermissionDescriptions property. For more information, see TemplatePermissionDescriptions Property.