org.bonitasoft.engine.bpm.process

Interface ProcessDeploymentInfo

All Superinterfaces:

BaseElement, BonitaObject, DescriptionElement, NamedElement, Serializable

public interface ProcessDeploymentInfo
extends DescriptionElement, BaseElement

Gives access to the ProcessDefinition deployment information.
A ProcessDeploymentInfo has a ConfigurationState, which says if the process is resolved (all its basic configuration has a proper value), or unresolved (some configuration has to be done before the process can be activated).

A ProcessDeploymentInfo has an ActivationState, which says if the process was set to enabled (logged users can start instances of this process), or disabled (no start can be performed on the process).

Author:

Baptiste Mesta, Yanyan Liu, Hongwen Zang, Celine Souchet, Emmanuel Duchastenier

See Also:

ProcessDefinition, ConfigurationState, ActivationState

Method Summary

Modifier and Type	Method and Description
ActivationState	getActivationState() Retrieves the ProcessDefinition ActivationState.
ConfigurationState	getConfigurationState() Retrieves the ProcessDefinition ConfigurationState.
long	getDeployedBy() Retrieves the identifier of the Bonita BPM User which deployed the ProcessDefinition
Date	getDeploymentDate() Retrieves the Date when the underlining ProcessDefinition was deployed.
String	getDisplayDescription() Retrieves the ProcessDefinition display description.
String	getDisplayName() Retrieves the ProcessDefinition display name.
String	getIconPath() Retrieves the process icon path.
Date	getLastUpdateDate() Retrieves the date of the last update statement
long	getProcessId() Retrieves the ProcessDefinition identifier
String	getVersion() Retrieves the ProcessDefinition version

Methods inherited from interface org.bonitasoft.engine.bpm.DescriptionElement

getDescription

Methods inherited from interface org.bonitasoft.engine.bpm.NamedElement

getName

Methods inherited from interface org.bonitasoft.engine.bpm.BaseElement

getId

Method Detail

getProcessId

long getProcessId()

Retrieves the ProcessDefinition identifier

Returns:

a long representing the ProcessDefinition identifier

See Also:

ProcessDefinition

getVersion

String getVersion()

Retrieves the ProcessDefinition version

Returns:

a String representing the ProcessDefinition version.

See Also:

ProcessDefinition

getDisplayDescription

String getDisplayDescription()

Retrieves the ProcessDefinition display description. Unlike description that is static, the display description can be updated via ProcessManagementAPI.updateProcessDeploymentInfo(long, ProcessDeploymentInfoUpdater).

When set, this field is used by the Bonita BPM Portal in the place of description.

Returns:

a String representing the ProcessDefinition display description.

See Also:

ProcessDefinition, ProcessManagementAPI.updateProcessDeploymentInfo(long, ProcessDeploymentInfoUpdater)

getDeploymentDate

Date getDeploymentDate()

Retrieves the Date when the underlining ProcessDefinition was deployed.

Returns:

the Date when the underlining ProcessDefinition was deployed.

See Also:

ProcessDefinition

getDeployedBy

long getDeployedBy()

Retrieves the identifier of the Bonita BPM User which deployed the ProcessDefinition

Returns:

a long representing the identifier of the Bonita BPM user which deployed the process.

See Also:

User, ProcessDefinition

getDisplayName

String getDisplayName()

Retrieves the ProcessDefinition display name. Unlike name that is static, the display name can be updated via ProcessManagementAPI.updateProcessDeploymentInfo(long, ProcessDeploymentInfoUpdater).

When set this field is used by the Bonita BPM Portal in the place of name.

Returns:

a String representing the ProcessDefinition display name.

See Also:

ProcessDefinition, ProcessManagementAPI.updateProcessDeploymentInfo(long, ProcessDeploymentInfoUpdater)

getLastUpdateDate

Date getLastUpdateDate()

Retrieves the date of the last update statement

Returns:

the date of the last update statement

getIconPath

String getIconPath()

Retrieves the process icon path. The path is relative to the bonita.home folder.

Returns:

a String representing the process icon path.

getConfigurationState

ConfigurationState getConfigurationState()

Retrieves the ProcessDefinition ConfigurationState.

Returns:

the ProcessDefinition ConfigurationState

See Also:

ProcessDefinition, ConfigurationState

getActivationState

ActivationState getActivationState()

Retrieves the ProcessDefinition ActivationState.

Returns:

the ProcessDefinition ActivationState