Package com.polarion.alm.tracker.workflow

Interface ISignaturePolicy<T extends IWorkflowObject>

public interface ISignaturePolicy<T extends IWorkflowObject>

Signature policy determines the overall signature state from a list of signatures. It is used to check whether a workflow transition (that uses the policy) can be performed (the transition will be allowed only if the policy verdict is ready), and to display the overall state for a signature context in the UI.

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
ISignatureStateOpt	getSignatureState(ICallContext<T> context, List<ISignature> signatures, IArguments arguments)	Returns the overall verdict determined from the individual signatures.
String	getStateMessage(ISignatureStateOpt state)	Returns message describing the state returned by this policy.

Method Details

getSignatureState

@NotNull
ISignatureStateOpt getSignatureState(@NotNull
 ICallContext<T> context,
 @NotNull
 List<ISignature> signatures,
 @NotNull
 IArguments arguments)

Returns the overall verdict determined from the individual signatures. Implementations will usually use context.getTarget().getProject().getSignatureStateEnum() to obtain the state enumeration options.

Parameters:

context - context of the execution

signatures - signatures to evaluate

arguments - policy arguments from configuration - not supported yet

getStateMessage

@Nullable
String getStateMessage(@NotNull
 ISignatureStateOpt state)

Returns message describing the state returned by this policy.