de.espirit.firstspirit.workflow.model

Interface WorkflowElement

All Known Subinterfaces:

Activity, State, Transition

public interface WorkflowElement

This interface represents an workflow-element from an workflow.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVITY This workflow-element implements Activity.
static String	PROPERTY_DESCRIPTION
static String	PROPERTY_DESCRIPTION_LANGUAGE
static String	PROPERTY_NAME
static String	PROPERTY_NAME_LANGUAGE
static int	STATE This workflow-element implements State.
static int	TRANSITION This workflow-element implements Transition.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description from this workflow-element.
String	getDescription(Language language) Returns the language dependant description from this workflow-element.
String	getDisplayName(Language language) Returns the language dependant name from this workflow-element.
long	getID()
String	getName() Deprecated. since 4.2.12 use getUid()
Object	getProperty(String key) Returns an property form this workflow-element.
int	getType() Returns the type of this workflow-element.
String	getUid() Returns the unique identifier of this workflow-element.
Workflow	getWorkflow() Returns the workflow this workflow-element belongs to.

Field Detail

PROPERTY_NAME

static final String PROPERTY_NAME

Since:

3.0

See Also:

Constant Field Values

PROPERTY_NAME_LANGUAGE

static final String PROPERTY_NAME_LANGUAGE

Since:

4.2.9

See Also:

Constant Field Values

PROPERTY_DESCRIPTION

static final String PROPERTY_DESCRIPTION

Since:

3.0

See Also:

Constant Field Values

PROPERTY_DESCRIPTION_LANGUAGE

static final String PROPERTY_DESCRIPTION_LANGUAGE

Since:

4.2.9

See Also:

Constant Field Values

ACTIVITY

static final int ACTIVITY

This workflow-element implements Activity.

Since:

3.0

See Also:

Constant Field Values

STATE

static final int STATE

This workflow-element implements State.

Since:

3.0

See Also:

Constant Field Values

TRANSITION

static final int TRANSITION

This workflow-element implements Transition.

Since:

3.0

See Also:

Constant Field Values

Method Detail

getID

long getID()

Returns:

the unique id for this workflow-element.

Since:

3.0

getName

@Deprecated
String getName()

Deprecated. since 4.2.12 use getUid()

Returns the name from this workflow-element.

Returns:

the name as a String.

Since:

3.0

getUid

String getUid()

Returns the unique identifier of this workflow-element.

Returns:

the uid of this TemplateSet

Since:

4.2.12

getDisplayName

@Nullable
String getDisplayName(Language language)

Returns the language dependant name from this workflow-element.

Returns:

the name as a String or null if the language dependant name is not defined

Since:

4.2.9

getDescription

@Nullable
String getDescription()

Returns the description from this workflow-element.

Returns:

the description or null if theres no description.

Since:

3.0

getDescription

@Nullable
String getDescription(Language language)

Returns the language dependant description from this workflow-element.

Returns:

the description or null if theres no language dependant description.

Since:

4.2.9

getType

int getType()

Returns the type of this workflow-element. Its either ACTIVITY), STATE) or TRANSITION).

Returns:

the type.

Since:

3.0

getProperty

Object getProperty(String key)

Returns an property form this workflow-element.

Returns:

an object that represents this protperty.

Since:

3.0

getWorkflow

Workflow getWorkflow()

Returns the workflow this workflow-element belongs to.

Returns:

the workflow.

Since:

3.0