de.aristaflow.adept2.model.processmodel.systemdata

Enum SystemDataProducer

java.lang.Object

java.lang.Enum<SystemDataProducer>

de.aristaflow.adept2.model.processmodel.systemdata.SystemDataProducer

All Implemented Interfaces:

LocalisedString, java.io.Serializable, java.lang.Comparable<SystemDataProducer>

public enum SystemDataProducer
extends java.lang.Enum<SystemDataProducer>
implements LocalisedString

This enumeration represents all process model methods that can produce system data, that is data which can be used normally in the data flow of a process. This is used for instance for dependent staff assignment rules (a node is to be performed by the same agent as some other node before). Such data is modelled explicitly as system parameters of a node which write an existing data element. The ExecutionManager takes care of retrieving the values from the process model methods and writing them to the corresponding data elements in the DataManager.
Data provided by templates and instances is written by the corresponding start node.

Every element of this enumeration represents a Parameter which is to be added at the corresponding node.

Author:

Ulrich Kreher

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE_CREATION_DATE Represents the date/time an instance has been created for usage as a value of a data element.
INSTANCE_INITIATOR_AGENT_ID Represents the agent ID of the instance initiator for usage as a value of a data element.
INSTANCE_INITIATOR_ORGPOSITION_ID Represents the organisational position ID of the instance initiator for usage as a value of a data element.
INSTANCE_SUPERVISOR_AGENT_ID Represents the agent ID of the instance supervisor for usage as a value of a data element.
INSTANCE_SUPERVISOR_ORGPOSITION_ID Represents the organisational position ID of the instance supervisor for usage as a value of a data element.
NODE_PERFORMING_AGENT_ID Represents the agent ID of the agent performing the designated node for usage as a value of a data element.
NODE_PERFORMING_ORGPOSITION_ID Represents the organisational ID of the agent performing the designated node for usage as a value of a data element.
NODE_STAFF_ASSIGNMENT_RULE Represents a staff assignment rule of a specific node for usage as a value of a data element.
NODE_TERMINATION_DATE Represents the date/time a node has been terminated for usage as a value of a data element.
TEMPLATE_SUPERVISOR_AGENT_ID Represents the agent ID of the template supervisor for usage as a value of a data element.
TEMPLATE_SUPERVISOR_ORGPOSITION_ID Represents the organisational position ID of the template supervisor for usage as a value of a data element.

Method Summary

Modifier and Type	Method and Description
SystemDataProducer	getCompanion() Gets the system data producer that is a companion of this.
ProcessModelParameter	getParameterProperties() Gets a parameter object providing all properties for the corresponding implicit system parameter
static SystemDataProducer	getProducerForIdentifierID(java.util.UUID identifierID) Returns the SystemDataProducer matching the specified identifier ID or null if there exists none.
static SystemDataProducer[]	nodeProduced() Gets all the values that are produced by arbitrary nodes.
static SystemDataProducer[]	startNodeProduced() Gets all the values that are produced by the start node, that is, the data stems from template or instance objects.
java.lang.Object	toLocalisedString(LocalisationFactory locFac, java.util.Locale loc) Gets the localised representation of the implementing object.
static SystemDataProducer	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SystemDataProducer[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEMPLATE_SUPERVISOR_AGENT_ID

public static final SystemDataProducer TEMPLATE_SUPERVISOR_AGENT_ID

Represents the agent ID of the template supervisor for usage as a value of a data element. Template.getSupervisorAgent() QualifiedAgent.getAgentID()

TEMPLATE_SUPERVISOR_ORGPOSITION_ID

public static final SystemDataProducer TEMPLATE_SUPERVISOR_ORGPOSITION_ID

Represents the organisational position ID of the template supervisor for usage as a value of a data element. Template.getSupervisorAgent() QualifiedAgent.getOrgPositionID()

INSTANCE_SUPERVISOR_AGENT_ID

public static final SystemDataProducer INSTANCE_SUPERVISOR_AGENT_ID

Represents the agent ID of the instance supervisor for usage as a value of a data element. Instance.getSupervisorAgent() QualifiedAgent.getAgentID()

INSTANCE_SUPERVISOR_ORGPOSITION_ID

public static final SystemDataProducer INSTANCE_SUPERVISOR_ORGPOSITION_ID

Represents the organisational position ID of the instance supervisor for usage as a value of a data element. Instance.getSupervisorAgent() QualifiedAgent.getOrgPositionID()

INSTANCE_INITIATOR_AGENT_ID

public static final SystemDataProducer INSTANCE_INITIATOR_AGENT_ID

Represents the agent ID of the instance initiator for usage as a value of a data element. Instance.getInitiatorAgent() QualifiedAgent.getAgentID()

INSTANCE_INITIATOR_ORGPOSITION_ID

public static final SystemDataProducer INSTANCE_INITIATOR_ORGPOSITION_ID

Represents the organisational position ID of the instance initiator for usage as a value of a data element. Instance.getInitiatorAgent() QualifiedAgent.getOrgPositionID()

NODE_PERFORMING_AGENT_ID

public static final SystemDataProducer NODE_PERFORMING_AGENT_ID

Represents the agent ID of the agent performing the designated node for usage as a value of a data element. Instance.getPerformingAgent(int) QualifiedAgent.getAgentID()

NODE_PERFORMING_ORGPOSITION_ID

public static final SystemDataProducer NODE_PERFORMING_ORGPOSITION_ID

Represents the organisational ID of the agent performing the designated node for usage as a value of a data element. Instance.getPerformingAgent(int) QualifiedAgent.getOrgPositionID()

NODE_STAFF_ASSIGNMENT_RULE

public static final SystemDataProducer NODE_STAFF_ASSIGNMENT_RULE

Represents a staff assignment rule of a specific node for usage as a value of a data element. The staff assignment rule of the node is written as a resolved rule which allows to have the very same set of agents to whom the corresponding activity is offered. This is needed for autostarting a node. Node.getStaffAssignmentRule()

INSTANCE_CREATION_DATE

public static final SystemDataProducer INSTANCE_CREATION_DATE

Represents the date/time an instance has been created for usage as a value of a data element. Instance.getCreationTime()

NODE_TERMINATION_DATE

public static final SystemDataProducer NODE_TERMINATION_DATE

Represents the date/time a node has been terminated for usage as a value of a data element.

Method Detail

values

public static SystemDataProducer[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SystemDataProducer c : SystemDataProducer.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SystemDataProducer valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getParameterProperties

public ProcessModelParameter getParameterProperties()

Gets a parameter object providing all properties for the corresponding implicit system parameter

Returns:

A parameter object providing all information needed for creating a corresponding system parameter.

getCompanion

public SystemDataProducer getCompanion()

Gets the system data producer that is a companion of this. This is used for data producers that are coupled, for instance specifying a qualified agent needs an agent ID and organisational position ID. If this system data producer does not have such a "companion" system data producer, null will be returned.

Returns:

The system data producer that is coupled to this system data producer or null in case there is no companion for this system data producer.

toLocalisedString

public java.lang.Object toLocalisedString(LocalisationFactory locFac,
                                          java.util.Locale loc)

Description copied from interface: LocalisedString

Gets the localised representation of the implementing object. The localisation should be for the designated locale, model objects being Localised should use the designated localisation factory for automatic localisation.

Specified by:

toLocalisedString in interface LocalisedString

Parameters:

locFac - The localisation factory to be used by Localised model objects. If this is null, do not localise the used Localised attributes.

loc - The locale for which to get the localised string. If this is null, treat it like Locale.ROOT has been requested.

Returns:

The localised (string) representation of the implementing object for the designated locale using the designated localisation factory if appropriate.

getProducerForIdentifierID

public static SystemDataProducer getProducerForIdentifierID(java.util.UUID identifierID)

Returns the SystemDataProducer matching the specified identifier ID or null if there exists none.

Parameters:

identifierID - the identifier ID for which to return the associated system data producer

Returns:

the SystemDataProducer matching the specified identifier ID or null if there exists none

startNodeProduced

public static SystemDataProducer[] startNodeProduced()

Gets all the values that are produced by the start node, that is, the data stems from template or instance objects.

Returns:

All the values produced by the start node (data that stems from template or instance objects.

nodeProduced

public static SystemDataProducer[] nodeProduced()

Gets all the values that are produced by arbitrary nodes.

Returns:

All the values produced by arbitrary nodes.