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

Interface IDocumentWorkflowSignaturesManager

All Superinterfaces:

IWorkflowSignaturesManager<IDocumentWorkflowSignature>

public interface IDocumentWorkflowSignaturesManager
extends IWorkflowSignaturesManager<IDocumentWorkflowSignature>

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
IDocumentWorkflowSignature	addWorkflowSignature(IStatusOpt targetStatus)	Adds open workflow signature for the target workflow status, or returns existing one.
IPObjectList<IUser>	getDocumentSigners()	Returns users that are allowed to sign target document. It counts with a custom set permissions that can be defined for target document.
List<IDocumentWorkflowSignature>	getSortedWorkflowSignatures()	Returns unmodifiable list of all existing workflow signatures.
IEnumeration<ISignatureVerdictOpt>	getVerdictEnumeration()	Returns the verdict enumeration for convenience.
IDocumentWorkflowSignature	getWorkflowSignature(IStatusOpt targetStatus)	Returns existing open workflow signature for target workflow status, or null.
void	removeWorkflowSignature(IStatusOpt targetStatus)	Removes open workflow signature for the target workflow status, if there is such workflow signature.

Method Details

getSortedWorkflowSignatures

@NotNull
List<IDocumentWorkflowSignature> getSortedWorkflowSignatures()

Returns unmodifiable list of all existing workflow signatures. Workflow signatures are sorted first by transition revision number, with workflow signatures without transition revision at the end, and then according to the target workflow status (sort order of statuses is defined by the enumeration).

Specified by:

getSortedWorkflowSignatures in interface IWorkflowSignaturesManager<IDocumentWorkflowSignature>

See Also:

• IDocumentWorkflowSignature

addWorkflowSignature

@NotNull
IDocumentWorkflowSignature addWorkflowSignature(@NotNull
 IStatusOpt targetStatus)

Adds open workflow signature for the target workflow status, or returns existing one.

Specified by:

addWorkflowSignature in interface IWorkflowSignaturesManager<IDocumentWorkflowSignature>

getWorkflowSignature

@Nullable
IDocumentWorkflowSignature getWorkflowSignature(@NotNull
 IStatusOpt targetStatus)

Returns existing open workflow signature for target workflow status, or null.

Specified by:

getWorkflowSignature in interface IWorkflowSignaturesManager<IDocumentWorkflowSignature>

removeWorkflowSignature

void removeWorkflowSignature(@NotNull
 IStatusOpt targetStatus)

Removes open workflow signature for the target workflow status, if there is such workflow signature.

Specified by:

removeWorkflowSignature in interface IWorkflowSignaturesManager<IDocumentWorkflowSignature>

getVerdictEnumeration

@NotNull
IEnumeration<ISignatureVerdictOpt> getVerdictEnumeration()

Returns the verdict enumeration for convenience. It will typically be used to convert verdict ID to ISignatureVerdictOpt.

Specified by:

getVerdictEnumeration in interface IWorkflowSignaturesManager<IDocumentWorkflowSignature>

getDocumentSigners

@NotNull
IPObjectList<IUser> getDocumentSigners()

Returns users that are allowed to sign target document.
It counts with a custom set permissions that can be defined for target document.

Returns:

users sorted by name

Since:

3.9.1