SignatureUtils (Technia Value Components (2023.2.0) API Documentation

java.lang.Object
- com.technia.tvc.core.db.SignatureUtils

public class SignatureUtils
extends java.lang.Object

Contains utility methods for working with signatures.

This class also contains methods that simplifies work with signatures from a datahandler or entry processor used in tables.

Look at this example:


 public void prepareEvaluation(Column column, EvaluationInput input) {
     SignatureUtils.prepareEvaluation(input, false);
 }
 
 public void populateCell(Cell cell, EvaluatedData data) {
     Iterator itr = SignatureUtils.getCurrentSignatures(data);
     while (itr.hasNext()) {
         Signature s = (Signature) itr.next();
         // doSomeThing(s);
     }
 }

OR, use this (slightly faster; less class instantiations...)


 public void prepareEvaluation(Column column, EvaluationInput input) {
     SignatureUtils.prepareEvaluation(input, false);
 }
 
 public void populateCell(Cell cell, EvaluatedData data) {
     Signature s = new Signature();
     Iterator itr = SignatureUtils.getCurrentSignatures(s, data);
     while (itr.hasNext()) {
         itr.next();
         // "s" is updated upon each iteration (the instance is reused).
         // doSomeThing(s);
     }
 }

Since:: 6.1.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SignatureUtils.Signature
Contains status about a single signature for a particular businessobject in a certain state.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SignatureUtils.Signature` Contains status about a single signature for a particular businessobject in a certain state.

Field Summary

Fields
Modifier and Type	Field and Description
`static Statement`	`CURRENT_SIGNATURE`
`static Statement`	`CURRENT_SIGNATURE_APPROVED`
`static Statement`	`CURRENT_SIGNATURE_COMMENT`
`static Statement`	`CURRENT_SIGNATURE_HASAPPROVE`
`static Statement`	`CURRENT_SIGNATURE_HASIGNORE`
`static Statement`	`CURRENT_SIGNATURE_HASREJECT`
`static Statement`	`CURRENT_SIGNATURE_IGNORED`
`static Statement`	`CURRENT_SIGNATURE_REJECTED`
`static Statement`	`CURRENT_SIGNATURE_SATISFIED`
`static Statement`	`CURRENT_SIGNATURE_SIGNED`
`static Statement`	`CURRENT_SIGNATURE_SIGNER`
`static Statement`	`STATE_SIGNATURE`
`static Statement`	`STATE_SIGNATURE_APPROVED`
`static Statement`	`STATE_SIGNATURE_COMMENT`
`static Statement`	`STATE_SIGNATURE_HASAPPROVE`
`static Statement`	`STATE_SIGNATURE_HASIGNORE`
`static Statement`	`STATE_SIGNATURE_HASREJECT`
`static Statement`	`STATE_SIGNATURE_IGNORED`
`static Statement`	`STATE_SIGNATURE_REJECTED`
`static Statement`	`STATE_SIGNATURE_SATISFIED`
`static Statement`	`STATE_SIGNATURE_SIGNED`
`static Statement`	`STATE_SIGNATURE_SIGNER`

Constructor Summary

Constructors
Constructor and Description

SignatureUtils()

Constructors
Constructor and Description
`SignatureUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`approve(java.lang.String objectId, java.lang.String signatureName, java.lang.String comment)` Approves a signature.
`static java.util.Iterator<SignatureUtils.Signature>`	`getAllSignatures(SelectedData data)`
`static java.util.Iterator<SignatureUtils.Signature>`	`getAllSignatures(SignatureUtils.Signature signature, SelectedData data)`
`static java.util.Iterator<SignatureUtils.Signature>`	`getCurrentSignatures(SelectedData data)`
`static java.util.Iterator<SignatureUtils.Signature>`	`getCurrentSignatures(SignatureUtils.Signature signature, SelectedData data)`
`static SignatureUtils.Signature[]`	`getSignatures(java.lang.String objectId)` Returns all signatures available in the current state for the given object.
`static void`	`ignore(java.lang.String objectId, java.lang.String signatureName, java.lang.String comment)` Ignores a signature
`static void`	`prepareEvaluation(EvaluationInput input, boolean all)` Convenient method for preparing a evaluation in a table, when there is a need to obtain signature information.
`static void`	`reject(java.lang.String objectId, java.lang.String signatureName, java.lang.String comment)` Rejects a signature.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATE_SIGNATURE

public static final Statement STATE_SIGNATURE

STATE_SIGNATURE_COMMENT

public static final Statement STATE_SIGNATURE_COMMENT

STATE_SIGNATURE_SIGNER

public static final Statement STATE_SIGNATURE_SIGNER

STATE_SIGNATURE_SIGNED

public static final Statement STATE_SIGNATURE_SIGNED

STATE_SIGNATURE_APPROVED

public static final Statement STATE_SIGNATURE_APPROVED

STATE_SIGNATURE_REJECTED

public static final Statement STATE_SIGNATURE_REJECTED

STATE_SIGNATURE_IGNORED

public static final Statement STATE_SIGNATURE_IGNORED

STATE_SIGNATURE_HASAPPROVE

public static final Statement STATE_SIGNATURE_HASAPPROVE

STATE_SIGNATURE_HASREJECT

public static final Statement STATE_SIGNATURE_HASREJECT

STATE_SIGNATURE_HASIGNORE

public static final Statement STATE_SIGNATURE_HASIGNORE

STATE_SIGNATURE_SATISFIED

public static final Statement STATE_SIGNATURE_SATISFIED

CURRENT_SIGNATURE

public static final Statement CURRENT_SIGNATURE

CURRENT_SIGNATURE_COMMENT

public static final Statement CURRENT_SIGNATURE_COMMENT

CURRENT_SIGNATURE_SIGNER

public static final Statement CURRENT_SIGNATURE_SIGNER

CURRENT_SIGNATURE_SIGNED

public static final Statement CURRENT_SIGNATURE_SIGNED

CURRENT_SIGNATURE_APPROVED

public static final Statement CURRENT_SIGNATURE_APPROVED

CURRENT_SIGNATURE_REJECTED

public static final Statement CURRENT_SIGNATURE_REJECTED

CURRENT_SIGNATURE_IGNORED

public static final Statement CURRENT_SIGNATURE_IGNORED

CURRENT_SIGNATURE_HASAPPROVE

public static final Statement CURRENT_SIGNATURE_HASAPPROVE

CURRENT_SIGNATURE_HASREJECT

public static final Statement CURRENT_SIGNATURE_HASREJECT

CURRENT_SIGNATURE_HASIGNORE

public static final Statement CURRENT_SIGNATURE_HASIGNORE

CURRENT_SIGNATURE_SATISFIED

public static final Statement CURRENT_SIGNATURE_SATISFIED

Constructor Detail
- SignatureUtils
```
public SignatureUtils()
```

Method Detail
- approve
```
public static void approve(java.lang.String objectId,
                           java.lang.String signatureName,
                           java.lang.String comment)
                    throws TVCException
```
  Approves a signature.
  
  Parameters:
  
  objectId -
  
  signatureName -
  
  comment -
  
  Throws:
  
  TVCException
  
  Since:
  
  6.1.0
- reject
```
public static void reject(java.lang.String objectId,
                          java.lang.String signatureName,
                          java.lang.String comment)
                   throws TVCException
```
  Rejects a signature.
  
  Parameters:
  
  objectId -
  
  signatureName -
  
  comment -
  
  Throws:
  
  TVCException
  
  Since:
  
  6.1.0
- ignore
```
public static void ignore(java.lang.String objectId,
                          java.lang.String signatureName,
                          java.lang.String comment)
                   throws TVCException
```
  Ignores a signature
  
  Parameters:
  
  objectId -
  
  signatureName -
  
  comment -
  
  Throws:
  
  TVCException
  
  Since:
  
  6.1.0
- getSignatures
```
public static SignatureUtils.Signature[] getSignatures(java.lang.String objectId)
                                                throws TVCException
```
  Returns all signatures available in the current state for the given object.
  Note that this method returns all signatures for the current state, even though there might exist branches. I.e. some signatures might lead to one state, while some other signatures might lead to another state.
  If you need information what states a signature actually is targetting to, the you should get that information from the PolicyInfo.getStateInfo(String) method.
  
  Parameters:
  
  objectId -
  
  Returns:
  
  An array of signatures available in the current state for the given object
  
  Throws:
  
  TVCException
  
  Since:
  
  6.1.0
- getCurrentSignatures
```
public static java.util.Iterator<SignatureUtils.Signature> getCurrentSignatures(SelectedData data)
```
  Parameters:
  
  data -
  
  Returns:
  
  An iterator of signatures
  
  Since:
  
  6.1.0
- getCurrentSignatures
```
public static java.util.Iterator<SignatureUtils.Signature> getCurrentSignatures(SignatureUtils.Signature signature,
                                                                                SelectedData data)
```
  Parameters:
  
  signature -
  
  data -
  
  Returns:
  
  An iterator of signatures
  
  Since:
  
  6.1.0
- getAllSignatures
```
public static java.util.Iterator<SignatureUtils.Signature> getAllSignatures(SelectedData data)
```
- getAllSignatures
```
public static java.util.Iterator<SignatureUtils.Signature> getAllSignatures(SignatureUtils.Signature signature,
                                                                            SelectedData data)
```
  Parameters:
  
  signature - If this parameter is null, then a new SignatureUtils.Signature instance is created upon each iteration. If non-null, then the same signature instance is reused over and over again.
  
  data - The selected data.
  
  Returns:
  
  An iterator used for iterating over all signatures
  
  Since:
  
  6.1.0
- prepareEvaluation
```
public static void prepareEvaluation(EvaluationInput input,
                                     boolean all)
```
  Convenient method for preparing a evaluation in a table, when there is a need to obtain signature information.
  
  Parameters:
  
  input - The EvaluationInput
  
  all - True if all signatures, independent of the current state of the object, should be retreived - or false, if only the signatures in the current state is of interest.
  
  Since:
  
  6.1.0

Class SignatureUtils

Nested Class Summary

Field Summary

Constructor Summary