Package com.orchestranetworks.addon.dqid

Class WorkflowIndicator

java.lang.Object

com.orchestranetworks.addon.dqid.Indicator

com.orchestranetworks.addon.dqid.WorkflowIndicator

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

DefaultWorkflowIndicator

public abstract class WorkflowIndicator
extends Indicator

This abstract class must be extended to define the behavior of an indicator run on a workflow.

Note that workflow indicators are executed based on the permissions of the user executing them. This means that if a user with no access permissions executes an indicator on a workflow publication, the indicator will provide no result.

The creator of the workflow model must specify a user or role in the workflow model permissions, under Workflow model configuration > Permission > Administration of workflows and re-publish the model.

Constructor Summary

Constructors

Constructor	Description
WorkflowIndicator()

Method Summary

Modifier and Type	Method	Description
abstract IndicatorReport	execute(WorkflowIndicatorExecutionContext executionContext)	Defines what the indicator will do.

Methods inherited from class com.orchestranetworks.addon.dqid.Indicator

getDefinition, getFlatDataAccessor, getIndicatorDefinitionContext, getIndicatorReportAccessor, getPrimaryKeyOrNullOfExistingIndicatorReport, getPrimaryKeyOrNullOfExistingIndicatorReportInBigDataTable, getPrimaryKeysOfExistingIndicatorValueParts

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowIndicator

public WorkflowIndicator()

Method Detail

execute

public abstract IndicatorReport execute(WorkflowIndicatorExecutionContext executionContext)
                                 throws DQIdException

Defines what the indicator will do.

Parameters:

executionContext - the WorkflowIndicatorExecutionContext specific to one execution.

Returns:

an IndicatorReport containing the values to save.

Throws:

DQIdException