State (FirstSpirit Access-API)

All Superinterfaces:

WorkflowElement
```
public interface State
extends WorkflowElement
```
This interface represents an state in an workflow-model.

Since:

3.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROPERTY_COLOR`
`static String`	`PROPERTY_DURATION`
`static String`	`PROPERTY_EDITOR_MODE`
`static String`	`PROPERTY_GROUPS`
`static String`	`PROPERTY_LOCATION`
`static String`	`PROPERTY_LOCK_STOREELEMENT`
`static String`	`PROPERTY_RELEASE`
`static String`	`PROPERTY_USER`
`static int`	`PROPERTY_VALUE_AUTOMATIC_EDITOR`
`static int`	`PROPERTY_VALUE_MANUAL_EDITOR`

Fields inherited from interface de.espirit.firstspirit.workflow.model.WorkflowElement
ACTIVITY, PROPERTY_DESCRIPTION, PROPERTY_DESCRIPTION_LANGUAGE, PROPERTY_NAME, PROPERTY_NAME_LANGUAGE, STATE, TRANSITION

Method Summary

Methods
Modifier and Type	Method and Description
`Color`	`getColor()` Returns the color that represents this state in the tree-model.
`long`	`getDuration()` Returns the maximum retention period for this state.
`int`	`getEditorMode()` Return the mode of the permission checking
`List<String>`	`getResponsibleGroups()` Returns the groups (names) who are responsible for this state.
`List<String>`	`getResponsibleUser()` Returns the user (login names) who are responsible for this state.
`List<? extends Transition>`	`getSourceTransitions()` Returns all transitions that points TO this state.
`boolean`	`getStoreElementLock()` Get StoreElement writelock
`List<? extends Transition>`	`getTargetTransitions()` Returns all Transitions which points FROM this state.
`boolean`	`isEndState()` Returns true if this state is an end-state; false otherwise.
`boolean`	`isErrorState()` Returns true if this state is an error-state; false otherwise.
`boolean`	`isStartState()` Returns true if this state is an start-state; false otherwise.
`boolean`	`releaseStoreElement()` Returns true if end-state and the store-element will be released when reached this state.

Methods inherited from interface de.espirit.firstspirit.workflow.model.WorkflowElement
getDescription, getDescription, getDisplayName, getID, getName, getProperty, getType, getUid, getWorkflow

- Field Detail
  - PROPERTY_VALUE_AUTOMATIC_EDITOR
```
static final int PROPERTY_VALUE_AUTOMATIC_EDITOR
```
    Since:
    
    3.0.7
    
    See Also:
    Constant Field Values
  - PROPERTY_VALUE_MANUAL_EDITOR
```
static final int PROPERTY_VALUE_MANUAL_EDITOR
```
    Since:
    
    3.0.7
    
    See Also:
    Constant Field Values
  - PROPERTY_LOCK_STOREELEMENT
```
static final String PROPERTY_LOCK_STOREELEMENT
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EDITOR_MODE
```
static final String PROPERTY_EDITOR_MODE
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_RELEASE
```
static final String PROPERTY_RELEASE
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_COLOR
```
static final String PROPERTY_COLOR
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_DURATION
```
static final String PROPERTY_DURATION
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_USER
```
static final String PROPERTY_USER
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_GROUPS
```
static final String PROPERTY_GROUPS
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_LOCATION
```
static final String PROPERTY_LOCATION
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
- Method Detail
  - getSourceTransitions
```
List<? extends Transition> getSourceTransitions()
```
    Returns all transitions that points TO this state.
    
    Returns:
    an list with all transitions or an empty list if there is no transition.
    Since:
    
    3.0
  - getTargetTransitions
```
List<? extends Transition> getTargetTransitions()
```
    Returns all Transitions which points FROM this state.
    
    Returns:
    an list with all transitions or an empty list if there is no transitions.
    Since:
    
    3.0
  - getColor
```
Color getColor()
```
    Returns the color that represents this state in the tree-model.
    
    Returns:
    the color.
    Since:
    
    3.0
  - getDuration
```
long getDuration()
```
    Returns the maximum retention period for this state.
    
    Returns:
    the duration or null if there no maximum retention period.
    Since:
    
    3.0
  - getResponsibleUser
```
List<String> getResponsibleUser()
```
    Returns the user (login names) who are responsible for this state.
    
    Since:
    
    3.0
  - getResponsibleGroups
```
List<String> getResponsibleGroups()
```
    Returns the groups (names) who are responsible for this state.
    
    Since:
    
    3.0
  - isStartState
```
boolean isStartState()
```
    Returns true if this state is an start-state; false otherwise.
    
    Since:
    
    3.0
  - isEndState
```
boolean isEndState()
```
    Returns true if this state is an end-state; false otherwise.
    
    Since:
    
    3.0
  - isErrorState
```
boolean isErrorState()
```
    Returns true if this state is an error-state; false otherwise.
    
    Since:
    
    4.0.120
  - releaseStoreElement
```
boolean releaseStoreElement()
```
    Returns true if end-state and the store-element will be released when reached this state.
    
    Since:
    
    3.0
  - getEditorMode
```
int getEditorMode()
```
    Return the mode of the permission checking
    
    Since:
    
    3.0.4
  - getStoreElementLock
```
boolean getStoreElementLock()
```
    Get StoreElement writelock
    
    Since:
    
    3.0.4

Interface State

Field Summary

Fields inherited from interface de.espirit.firstspirit.workflow.model.WorkflowElement

Method Summary

Methods inherited from interface de.espirit.firstspirit.workflow.model.WorkflowElement

Field Detail

PROPERTY_VALUE_AUTOMATIC_EDITOR

PROPERTY_VALUE_MANUAL_EDITOR

PROPERTY_LOCK_STOREELEMENT

PROPERTY_EDITOR_MODE

PROPERTY_RELEASE

PROPERTY_COLOR

PROPERTY_DURATION

PROPERTY_USER

PROPERTY_GROUPS

PROPERTY_LOCATION

Method Detail

getSourceTransitions

getTargetTransitions

getColor

getDuration

getResponsibleUser

getResponsibleGroups

isStartState

isEndState

isErrorState

releaseStoreElement

getEditorMode

getStoreElementLock