A C D E G I J K L M O P R S T U V

A

AttributePermissionDescriptorImpl - class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl.

AttributePermissionDescriptorImpl() - Constructor for class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

Creates a new instance of PermissionDescriptor

AttributePermissionDescriptorImpl.ValidatorInstanciationException - exception org.openemcee.microflow.impl.AttributePermissionDescriptorImpl.ValidatorInstanciationException.

AttributePermissionDescriptorImpl.ValidatorInstanciationException(String, Throwable) - Constructor for class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl.ValidatorInstanciationException

addAttribute(String, Object) - Method in class org.openemcee.microflow.frontend.MicroflowRunner

Add microflow data to the workflow.

addAttributePermission(AttributePermissionDescriptorImpl) - Method in class org.openemcee.microflow.impl.MicroflowDataDescriptorImpl

addInitialMicroflowData(String, Object) - Method in class org.openemcee.microflow.impl.MicroflowExecutor

addIntialMicroflowData(String, Object, Class) - Method in class org.openemcee.microflow.impl.MicroflowExecutor

addOutcomeDescriptor(TaskOutcomeDescriptor) - Method in class org.openemcee.microflow.impl.TaskDescriptor

addParameter(String, String) - Method in class org.openemcee.microflow.impl.KVParams

addParameter(String, String) - Method in class org.openemcee.microflow.impl.TaskDescriptor

addParameter(String, String) - Method in class org.openemcee.microflow.impl.ValidatorConfigImpl

addRuleInstances(Digester) - Method in class org.openemcee.microflow.config.ConfigRuleSet

This method implements the rules for converting the Microflow XML to an object.

C

CallSubflowTask - class org.openemcee.microflow.tasks.CallSubflowTask.

This task is called to execute a Microflow from another Microflow.

CallSubflowTask() - Constructor for class org.openemcee.microflow.tasks.CallSubflowTask

Creates a new instance of CallSubflowTask

ChainedException - exception org.openemcee.commons.exceptions.ChainedException.

This class implements an exception which can be chained to other exceptions, in the style of the SQLException.

ChainedException(String, Throwable) - Constructor for class org.openemcee.commons.exceptions.ChainedException

Creates a new instance of ChainedException

ConfigRuleSet - class org.openemcee.microflow.config.ConfigRuleSet.

This class implements the logic necessary to convert the microflow XML to java objects used in execution.

ConfigRuleSet() - Constructor for class org.openemcee.microflow.config.ConfigRuleSet

CreationException - exception org.openemcee.microflow.impl.CreationException.

CreationException(String) - Constructor for class org.openemcee.microflow.impl.CreationException

Creates a new instance of CreationException

clearParams() - Method in class org.openemcee.microflow.impl.KVParams

D

deepCopy() - Method in class org.openemcee.microflow.impl.MicroflowDataDescriptorImpl

E

exec - Variable in class org.openemcee.microflow.frontend.MicroflowRunner

This is the executor under which this Microflow will be run.

execute() - Method in class org.openemcee.microflow.impl.MicroflowExecutor

executeTask(MicroflowData) - Method in class org.openemcee.microflow.tasks.CallSubflowTask

See class description.

executeTask(MicroflowData) - Method in interface org.openemcee.microflow.usercore.MicroflowTask

This method is where the callouts to model components occurrs, as well as determination of "outcome".

G

getAccessedData() - Method in class org.openemcee.microflow.impl.MicroflowDataImpl

getAliases() - Method in class org.openemcee.microflow.impl.PermissionedData

Getter for property aliases.

getAttribute(String) - Method in class org.openemcee.microflow.frontend.MicroflowRunner

Retrieve a named attribute.

getAttribute(String) - Method in class org.openemcee.microflow.impl.MicroflowDataImpl

getAttribute(String) - Method in class org.openemcee.microflow.impl.MicroflowExecutor

getAttribute(String) - Method in interface org.openemcee.microflow.usercore.MicroflowData

Retrieve data from the microflow by name.

getAttributePermission(String) - Method in class org.openemcee.microflow.impl.MicroflowDataDescriptorImpl

getChained() - Method in class org.openemcee.commons.exceptions.ChainedException

Access the exception which caused this to be thrown.

getData() - Method in class org.openemcee.microflow.impl.MicroflowExecutor

Getter for property data.

getExec() - Method in class org.openemcee.microflow.frontend.MicroflowRunner

Getter for property exec.

getFirstTaskName() - Method in class org.openemcee.microflow.impl.JobDescriptor

Getter for property firstTaskName.

getIdentifier() - Method in class org.openemcee.microflow.impl.JobDescriptor

Getter for property identifier.

getInitalDataDescriptor() - Method in class org.openemcee.microflow.impl.JobDescriptor

getJob(String) - Method in class org.openemcee.microflow.frontend.MicroflowFactory

Access a job from an XML descriptor.

getKVParams() - Method in class org.openemcee.microflow.impl.ValidatorConfigImpl

Getter for property params.

getMessage() - Method in class org.openemcee.commons.exceptions.ChainedException

Get the message associated with this exception.

getMicroflowTaskClass() - Method in class org.openemcee.microflow.impl.TaskDescriptor

Getter for property microflowTaskClass.

getName() - Method in class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

Getter for property name.

getName() - Method in class org.openemcee.microflow.impl.PermissionedData

Getter for property name.

getName() - Method in class org.openemcee.microflow.impl.TaskDescriptor

Getter for property name.

getName() - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Getter for property name.

getName() - Method in class org.openemcee.microflow.usercore.MicroflowTaskOutcome

Getter for property name.

getNextTaskName() - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Getter for property nextTaskName.

getOutcomeDescriptor(String) - Method in class org.openemcee.microflow.impl.TaskDescriptor

getParameter(String) - Method in class org.openemcee.microflow.impl.KVParams

getParameter(String, String) - Method in class org.openemcee.microflow.impl.KVParams

getParameter(String) - Method in interface org.openemcee.microflow.usercore.MicroflowParameters

Retrieve a parameter of this name, if it is not set, this returns null.

getParameter(String, String) - Method in interface org.openemcee.microflow.usercore.MicroflowParameters

Retrieve a parameter of this name, if it is not set, return a default value.

getParameterNames() - Method in class org.openemcee.microflow.impl.KVParams

getParameterNames() - Method in interface org.openemcee.microflow.usercore.MicroflowParameters

Retrieve a list of all the parameters available in this parameter bag.

getParams() - Method in class org.openemcee.microflow.impl.TaskDescriptor

Getter for property params.

getRunner(String) - Method in class org.openemcee.microflow.frontend.MicroflowFactory

Access a job from an XML job descriptor.

getTaskDescriptorByName(String, TaskDescriptor) - Method in class org.openemcee.microflow.impl.JobDescriptor

Returns any exsiting descriptor if found.

getTaskDescriptorByName(String) - Method in class org.openemcee.microflow.impl.JobDescriptor

getTaskInstance() - Method in class org.openemcee.microflow.impl.TaskDescriptor

getTaskInstance(Class) - Method in class org.openemcee.microflow.impl.TaskDescriptor

getType() - Method in class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

Getter for property type.

getType() - Method in class org.openemcee.microflow.impl.PermissionedData

Getter for property type.

getUndoClass() - Method in class org.openemcee.microflow.impl.TaskDescriptor

Getter for property undoClass.

getValidator() - Method in class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

getValidator(String) - Method in class org.openemcee.microflow.impl.MicroflowDataDescriptorImpl

getValidator() - Method in class org.openemcee.microflow.impl.PermissionedData

Getter for property validator.

getValidatorConfig() - Method in class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

Getter for property validatorConfig.

getValidatorType() - Method in class org.openemcee.microflow.impl.ValidatorConfigImpl

Getter for property validatorType.

I

init(MicroflowParameters) - Method in class org.openemcee.microflow.tasks.CallSubflowTask

init(MicroflowParameters) - Method in interface org.openemcee.microflow.usercore.MicroflowTask

This method is called once, and only once, prior to calling execute task.

isAllowed(String, Class) - Method in class org.openemcee.microflow.impl.MicroflowDataDescriptorImpl

isAllowed(String, Class) - Method in interface org.openemcee.microflow.usercore.MicroflowDataDescriptor

Determines if an object of this type is allowed to be added to the data to which this is associated.

isFailure() - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Getter for property failure.

isTerminal() - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Getter for property terminal.

J

JobDescriptor - class org.openemcee.microflow.impl.JobDescriptor.

JobDescriptor() - Constructor for class org.openemcee.microflow.impl.JobDescriptor

Creates a new instance of Job

K

KVParams - class org.openemcee.microflow.impl.KVParams.

KVParams() - Constructor for class org.openemcee.microflow.impl.KVParams

Creates a new instance of KVParams

L

LAST_OUTCOME_KEY - Static variable in class org.openemcee.microflow.impl.MicroflowExecutor

M

MICROFLOW_FACTORY_KEY - Static variable in class org.openemcee.microflow.frontend.MicroflowFactory

Microflows created with the factory will have access to the creating factory, by accessing the named attribute at this key.

MicroflowData - interface org.openemcee.microflow.usercore.MicroflowData.

This interface provides access to the data associated with a microflow.

MicroflowDataDescriptor - interface org.openemcee.microflow.usercore.MicroflowDataDescriptor.

This interface is used to determine if a particular attribute is allowed in a given Microflow instance.

MicroflowDataDescriptorImpl - class org.openemcee.microflow.impl.MicroflowDataDescriptorImpl.

MicroflowDataDescriptorImpl() - Constructor for class org.openemcee.microflow.impl.MicroflowDataDescriptorImpl

Creates a new instance of MicroflowDataDescriptorImpl

MicroflowDataDescriptorImpl(MicroflowDataDescriptorImpl) - Constructor for class org.openemcee.microflow.impl.MicroflowDataDescriptorImpl

MicroflowDataImpl - class org.openemcee.microflow.impl.MicroflowDataImpl.

MicroflowDataImpl(MicroflowDataDescriptorImpl) - Constructor for class org.openemcee.microflow.impl.MicroflowDataImpl

Creates a new instance of MicroflowDataImpl

MicroflowExecutor - class org.openemcee.microflow.impl.MicroflowExecutor.

MicroflowExecutor(JobDescriptor) - Constructor for class org.openemcee.microflow.impl.MicroflowExecutor

Creates a new instance of MicroflowExecutor

MicroflowExecutor.DataIntegrityException - exception org.openemcee.microflow.impl.MicroflowExecutor.DataIntegrityException.

MicroflowExecutor.DataIntegrityException(String) - Constructor for class org.openemcee.microflow.impl.MicroflowExecutor.DataIntegrityException

MicroflowExecutor.ExecutorError - exception org.openemcee.microflow.impl.MicroflowExecutor.ExecutorError.

MicroflowExecutor.ExecutorError(String, Throwable) - Constructor for class org.openemcee.microflow.impl.MicroflowExecutor.ExecutorError

MicroflowExecutor.ValidationException - exception org.openemcee.microflow.impl.MicroflowExecutor.ValidationException.

MicroflowExecutor.ValidationException(String) - Constructor for class org.openemcee.microflow.impl.MicroflowExecutor.ValidationException

MicroflowExecutor.WorkflowBusinessFailure - exception org.openemcee.microflow.impl.MicroflowExecutor.WorkflowBusinessFailure.

MicroflowExecutor.WorkflowBusinessFailure(String) - Constructor for class org.openemcee.microflow.impl.MicroflowExecutor.WorkflowBusinessFailure

MicroflowFactory - class org.openemcee.microflow.frontend.MicroflowFactory.

The Microflow factory is a Façade which provides simplified access to flows.

MicroflowFactory(String) - Constructor for class org.openemcee.microflow.frontend.MicroflowFactory

Creates a new instance of MicroflowLauncher.

MicroflowFactory.MicroflowNotFoundException - exception org.openemcee.microflow.frontend.MicroflowFactory.MicroflowNotFoundException.

The requested microflow was not found.

MicroflowFactory.MicroflowNotFoundException(String, Throwable) - Constructor for class org.openemcee.microflow.frontend.MicroflowFactory.MicroflowNotFoundException

Create a microflow, chaining the route cause.

MicroflowParameters - interface org.openemcee.microflow.usercore.MicroflowParameters.

This interface provides access to parameters being passed to a Microflow entity (ex.

MicroflowRunner - class org.openemcee.microflow.frontend.MicroflowRunner.

The Microflow runner is a Façade which makes execution of a Microflow more user friendly.

MicroflowRunner(JobDescriptor) - Constructor for class org.openemcee.microflow.frontend.MicroflowRunner

Creates a new instance of MicroflowExecution, given a JobDescriptor instance.

MicroflowRunner.BusinessException - exception org.openemcee.microflow.frontend.MicroflowRunner.BusinessException.

See documentation for "run()".

MicroflowRunner.BusinessException(String, Throwable) - Constructor for class org.openemcee.microflow.frontend.MicroflowRunner.BusinessException

Creates an instance of BusinessException.

MicroflowRunner.DataIntegrityException - exception org.openemcee.microflow.frontend.MicroflowRunner.DataIntegrityException.

See documentation for "run()".

MicroflowRunner.DataIntegrityException(String, Throwable) - Constructor for class org.openemcee.microflow.frontend.MicroflowRunner.DataIntegrityException

Create an instance of this excepton

MicroflowRunner.MicroflowException - exception org.openemcee.microflow.frontend.MicroflowRunner.MicroflowException.

See documentation for "run()".

MicroflowRunner.MicroflowException(String, Throwable) - Constructor for class org.openemcee.microflow.frontend.MicroflowRunner.MicroflowException

Base class for all failure types.

MicroflowRunner.MicroflowFailure - exception org.openemcee.microflow.frontend.MicroflowRunner.MicroflowFailure.

See documentation for "run()".

MicroflowRunner.MicroflowFailure(String, Throwable) - Constructor for class org.openemcee.microflow.frontend.MicroflowRunner.MicroflowFailure

Create an instance of this excepton

MicroflowTask - interface org.openemcee.microflow.usercore.MicroflowTask.

The MicroflowTask is the caore interface controller plugins in the OpenEmcee microflow framework.

MicroflowTaskOutcome - class org.openemcee.microflow.usercore.MicroflowTaskOutcome.

A Microflow task outcome is the high level result from executing a MicroflowTask.

MicroflowTaskOutcome(String) - Constructor for class org.openemcee.microflow.usercore.MicroflowTaskOutcome

Creates a new instance of MicroflowTaskOutcome

O

org.openemcee.commons.exceptions - package org.openemcee.commons.exceptions

org.openemcee.microflow.config - package org.openemcee.microflow.config

org.openemcee.microflow.frontend - package org.openemcee.microflow.frontend

org.openemcee.microflow.impl - package org.openemcee.microflow.impl

org.openemcee.microflow.tasks - package org.openemcee.microflow.tasks

org.openemcee.microflow.usercore - package org.openemcee.microflow.usercore

P

PermissionedData - class org.openemcee.microflow.impl.PermissionedData.

PermissionedData() - Constructor for class org.openemcee.microflow.impl.PermissionedData

Creates a new instance of PermissionedData

PermissionedDataValidator - interface org.openemcee.microflow.usercore.PermissionedDataValidator.

The permissioned data validator interface is used to provide data validation to data in a Microflow.

printStackTrace() - Method in class org.openemcee.commons.exceptions.ChainedException

Print a stack trace to standard error, recursing any chained exceptions.

printStackTrace(PrintStream) - Method in class org.openemcee.commons.exceptions.ChainedException

Print a stack trace to a PrintStream, recursing any chained exceptions.

printStackTrace(PrintWriter) - Method in class org.openemcee.commons.exceptions.ChainedException

Print a stack trace to a PrintWriter, recursing any chained exceptions.

R

resetAccessedData() - Method in class org.openemcee.microflow.impl.MicroflowDataImpl

run() - Method in class org.openemcee.microflow.frontend.MicroflowRunner

Run the microflow.

S

SUBFLOW_EXCEPTION_KEY - Static variable in class org.openemcee.microflow.impl.MicroflowExecutor

setAliases(String[]) - Method in class org.openemcee.microflow.impl.PermissionedData

Setter for property aliases.

setAttribute(String, Object) - Method in class org.openemcee.microflow.impl.MicroflowDataImpl

setAttribute(String, Object) - Method in interface org.openemcee.microflow.usercore.MicroflowData

Set this named attribute in the microflow.

setFailure(boolean) - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Setter for property failure.

setFirstTaskName(String) - Method in class org.openemcee.microflow.impl.JobDescriptor

Setter for property firstTaskName.

setIdentifier(String) - Method in class org.openemcee.microflow.impl.JobDescriptor

Setter for property identifier.

setInitialDataDescriptor(MicroflowDataDescriptorImpl) - Method in class org.openemcee.microflow.impl.JobDescriptor

setMicroflowTaskClass(Class) - Method in class org.openemcee.microflow.impl.TaskDescriptor

Setter for property microflowTaskClass.

setMicroflowTaskClassName(String) - Method in class org.openemcee.microflow.impl.TaskDescriptor

setName(String) - Method in class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

Setter for property name.

setName(String) - Method in class org.openemcee.microflow.impl.PermissionedData

Setter for property name.

setName(String) - Method in class org.openemcee.microflow.impl.TaskDescriptor

Setter for property name.

setName(String) - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Setter for property name.

setName(String) - Method in class org.openemcee.microflow.usercore.MicroflowTaskOutcome

Setter for property name.

setNextTaskName(String) - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Setter for property nextTaskName.

setParameters(MicroflowParameters) - Method in interface org.openemcee.microflow.usercore.PermissionedDataValidator

Will always be called prior to the first validate.

setParams(KVParams) - Method in class org.openemcee.microflow.impl.TaskDescriptor

Setter for property params.

setTaskDescriptor(TaskDescriptor) - Method in class org.openemcee.microflow.impl.JobDescriptor

setTerminal(boolean) - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Setter for property terminal.

setType(Class) - Method in class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

Setter for property type.

setType(Class) - Method in class org.openemcee.microflow.impl.PermissionedData

Setter for property type.

setTypeName(String) - Method in class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

setUndoClass(Class) - Method in class org.openemcee.microflow.impl.TaskDescriptor

Setter for property undoClass.

setUndoClassName(String) - Method in class org.openemcee.microflow.impl.TaskDescriptor

setValidating(boolean) - Method in class org.openemcee.microflow.frontend.MicroflowFactory

Tell the parser to validate.

setValidator(PermissionedDataValidator) - Method in class org.openemcee.microflow.impl.PermissionedData

Setter for property validator.

setValidatorClassName(String) - Method in class org.openemcee.microflow.impl.ValidatorConfigImpl

setValidatorConfig(ValidatorConfigImpl) - Method in class org.openemcee.microflow.impl.AttributePermissionDescriptorImpl

Setter for property validatorConfig.

setValidatorType(Class) - Method in class org.openemcee.microflow.impl.ValidatorConfigImpl

Setter for property validatorType.

T

TaskDescriptor - class org.openemcee.microflow.impl.TaskDescriptor.

TaskDescriptor() - Constructor for class org.openemcee.microflow.impl.TaskDescriptor

Creates a new instance of TaskDefinition

TaskOutcomeDescriptor - class org.openemcee.microflow.impl.TaskOutcomeDescriptor.

TaskOutcomeDescriptor() - Constructor for class org.openemcee.microflow.impl.TaskOutcomeDescriptor

Creates a new instance of TaskOutcomeDescriptor

toString(StringBuffer) - Method in class org.openemcee.commons.exceptions.ChainedException

Append a recursive string representation to the StringBuffer.

toString() - Method in class org.openemcee.commons.exceptions.ChainedException

Get a resursive string representation of this exception (and all that are chained).

toString() - Method in class org.openemcee.microflow.impl.KVParams

toString() - Method in class org.openemcee.microflow.impl.TaskDescriptor

toString() - Method in class org.openemcee.microflow.impl.TaskOutcomeDescriptor

U

UNDO_STACK_KEY - Static variable in class org.openemcee.microflow.impl.MicroflowExecutor

UnknownDescriptorException - exception org.openemcee.microflow.impl.UnknownDescriptorException.

UnknownDescriptorException() - Constructor for class org.openemcee.microflow.impl.UnknownDescriptorException

Creates a new instance of UnknownDescriptorException without detail message.

UnknownDescriptorException(String) - Constructor for class org.openemcee.microflow.impl.UnknownDescriptorException

Constructs an instance of UnknownDescriptorException with the specified detail message.

undo(ArrayStack) - Method in class org.openemcee.microflow.impl.MicroflowExecutor

V

VCS_ID - Static variable in interface org.openemcee.microflow.usercore.MicroflowData

Version control info.

VCS_ID - Static variable in interface org.openemcee.microflow.usercore.MicroflowDataDescriptor

Version control header.

VCS_ID - Static variable in interface org.openemcee.microflow.usercore.MicroflowParameters

Version control info.

VCS_ID - Static variable in interface org.openemcee.microflow.usercore.MicroflowTask

Version control tag.

VCS_ID - Static variable in interface org.openemcee.microflow.usercore.PermissionedDataValidator

Version control tag.

ValidatorConfigImpl - class org.openemcee.microflow.impl.ValidatorConfigImpl.

ValidatorConfigImpl() - Constructor for class org.openemcee.microflow.impl.ValidatorConfigImpl

Creates a new instance of ValidatorConfigImpl

validate(Object) - Method in interface org.openemcee.microflow.usercore.PermissionedDataValidator

This method is called after a task executes, any time that validated, permissioned data is accessed or modified.

A C D E G I J K L M O P R S T U V