Package com.polarion.alm.tracker.model.signatures

Interface IDocumentWorkflowSignature

All Superinterfaces:

IAdaptable, IChangeListener, IHasCustomValues, IHasValues, IPObject, IUniqueObject, IWorkflowSignature

public interface IDocumentWorkflowSignature
extends IWorkflowSignature

Document workflow signature represents a signature for one transition to a workflow status of a document.

Since:

3.9.0

See Also:

• IWorkflowSignature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_BRANCHED_FROM
static final String	PROTO

Fields inherited from interface com.polarion.alm.projects.model.IUniqueObject

KEY_ID, KEY_PROJECT

Fields inherited from interface com.polarion.alm.tracker.model.signatures.IWorkflowSignature

ENUM_ID_SIGNATURE_STATE, KEY_SIGNATURE_STATE, KEY_SIGNATURES, KEY_TARGET_STATUS_ID, KEY_TRANSITION_DATA_REVISION, KEY_WORKFLOW_OBJECT

Method Summary

Modifier and Type	Method	Description
IDocumentWorkflowSignature	getBranchedFrom()	The signature of which this workflow signature is a branch.
String	getTransitionRevision()	Revision of the parent object in which the workflow transition was performed, or null if the transition was not performed yet.
IModule	getWorkflowObject()	The document to which this workflow signature belongs.
void	setBranchedFrom(IDocumentWorkflowSignature branchedFrom)

Methods inherited from interface com.polarion.platform.persistence.model.IAdaptable

adapt

Methods inherited from interface com.polarion.platform.persistence.model.IChangeListener

markChanged

Methods inherited from interface com.polarion.platform.persistence.model.IHasCustomValues

getCustomField, getCustomFieldPrototype, getCustomFieldsList, setCustomField

Methods inherited from interface com.polarion.platform.persistence.model.IPObject

can, copyTo, createStructureForKey, forget, getContextId, getDataRevision, getDataSvc, getEnumerationOptionForField, getEnumerationTypeForField, getFieldLabel, getFieldType, getIncompatibleCustomField, getIncompatibleCustomFieldPrototype, getIncompatibleCustomFieldsList, getLastRevision, getLocalId, getObjectId, getPrototype, getRevision, getUri, getValue, isModified, isPersisted, isReadOnly, isResolved, isUnresolvable, resolve, save, setEnumerationValue, setValue, update

Methods inherited from interface com.polarion.alm.projects.model.IUniqueObject

getId, getProject, getProjectId

Methods inherited from interface com.polarion.alm.tracker.model.signatures.IWorkflowSignature

addSignature, getLabel, getSignature, getSignatures, getSignatureState, getTargetStatus, isClosed, removeSignature, resetSignatures, setObsolete

Field Details

PROTO

@NotNull
static final String PROTO

See Also:

• Constant Field Values

KEY_BRANCHED_FROM

@NotNull
static final String KEY_BRANCHED_FROM

See Also:

• Constant Field Values

Method Details

getWorkflowObject

@NotNull
IModule getWorkflowObject()

The document to which this workflow signature belongs.

Specified by:

getWorkflowObject in interface IWorkflowSignature

getTransitionRevision

@Nullable
String getTransitionRevision()

Revision of the parent object in which the workflow transition was performed, or null if the transition was not performed yet. If the signature is branched from another document, the transition revision will be of the source document.

Specified by:

getTransitionRevision in interface IWorkflowSignature

getBranchedFrom

@Nullable
IDocumentWorkflowSignature getBranchedFrom()

The signature of which this workflow signature is a branch. If filled, getWorkflowObject() is a document branched from getBranchedFrom() and the signature was created before branching and was copied to this document as this signature.

See Also:

• IModule.getBranchedFrom()

setBranchedFrom

void setBranchedFrom(@Nullable
 IDocumentWorkflowSignature branchedFrom)