Transition (FirstSpirit Access-API)

All Superinterfaces:

WorkflowElement
```
public interface Transition
extends WorkflowElement
```
This interface represents an transition in the workflow-model.

Since:

3.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EMAIL_ALLOWED`
`static int`	`EMAIL_EDITORS`
`static int`	`EMAIL_LAST_AGENT`
`static int`	`EMAIL_LIST`
`static int`	`EMAIL_SEND`
`static int`	`EMAIL_TASK_CREATOR`
`static String`	`PROPERTY_EMAIL_BENEFICIARY`
`static String`	`PROPERTY_EMAIL_BODY`
`static String`	`PROPERTY_EMAIL_EDITORS`
`static String`	`PROPERTY_EMAIL_GROUPS`
`static String`	`PROPERTY_EMAIL_LAST_AGENT`
`static String`	`PROPERTY_EMAIL_LIST`
`static String`	`PROPERTY_EMAIL_SEND`
`static String`	`PROPERTY_EMAIL_SUBJECT`
`static String`	`PROPERTY_EMAIL_TASK_CREATOR`
`static String`	`PROPERTY_EMAIL_USER`
`static String`	`PROPERTY_FIXED_RIGHTS`
`static String`	`PROPERTY_GROUPS`
`static String`	`PROPERTY_LABEL_POS`
`static String`	`PROPERTY_NO_EDITOR_GROUPS`
`static String`	`PROPERTY_POINTS`
`static String`	`PROPERTY_PORT_SOURCE`
`static String`	`PROPERTY_PORT_TARGET`
`static String`	`PROPERTY_STOREELEMENT_RIGHTS`
`static String`	`PROPERTY_TASK_RIGHTS`
`static String`	`PROPERTY_USED_STOREELEMENT_RIGHT`
`static String`	`PROPERTY_USED_TASK_RIGHTS`
`static String`	`PROPERTY_USER`
`static int`	`PROPERTY_VALUE_EAST_PORT`
`static int`	`PROPERTY_VALUE_NO_PORT`
`static int`	`PROPERTY_VALUE_NORTH_PORT`
`static int`	`PROPERTY_VALUE_SOUTH_PORT`
`static int`	`PROPERTY_VALUE_WEST_PORT`
`static int`	`TASK_RIGHT_CREATOR`
`static int`	`TASK_RIGHT_LAST_ACTION_USER`
`static int`	`TASK_RIGHT_LAST_USER`
`static int[]`	`TASK_RIGHTS`

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
`List<String>`	`getAllowedGroups()` Returns all groups that are allowed to do this transition.
`List<String>`	`getAllowedUsers()` Returns all user that are allowed to do this transition.
`String`	`getEmailBody()` Returns the text from the email.
`List<String>`	`getEmailGroups()`
`boolean`	`getEmailProperty(int property)` Returns true if this activity has the given property
`String`	`getEmailSubject()` Returns the title from the email.
`List<String>`	`getEmailUser()` Returns the user who are selected to be notiefied by mail.
`List<String>`	`getNoEditorGroups()` Groups marked as no editor are not preselected as editor.
`WorkflowElement`	`getSource()` Returns the workflow-element this transitions points FROM.
`WorkflowElement`	`getTarget()` Returns the workflow-element this transitions points TO.
`int`	`getUsedStoreElementRights()`
`int`	`getUsedTaskRights()`
`boolean`	`useFixedRights()`
`boolean`	`useStoreElementRights()`
`boolean`	`useTaskRights()`

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

- Field Detail
  - TASK_RIGHT_CREATOR
```
static final int TASK_RIGHT_CREATOR
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - TASK_RIGHT_LAST_USER
```
static final int TASK_RIGHT_LAST_USER
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - TASK_RIGHT_LAST_ACTION_USER
```
static final int TASK_RIGHT_LAST_ACTION_USER
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - TASK_RIGHTS
```
static final int[] TASK_RIGHTS
```
    Since:
    
    3.0.4
  - PROPERTY_FIXED_RIGHTS
```
static final String PROPERTY_FIXED_RIGHTS
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_STOREELEMENT_RIGHTS
```
static final String PROPERTY_STOREELEMENT_RIGHTS
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_TASK_RIGHTS
```
static final String PROPERTY_TASK_RIGHTS
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_USED_STOREELEMENT_RIGHT
```
static final String PROPERTY_USED_STOREELEMENT_RIGHT
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_USED_TASK_RIGHTS
```
static final String PROPERTY_USED_TASK_RIGHTS
```
    Since:
    
    3.0.4
    
    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_NO_EDITOR_GROUPS
```
static final String PROPERTY_NO_EDITOR_GROUPS
```
    Since:
    
    3.0.79
    
    See Also:
    Constant Field Values
  - PROPERTY_POINTS
```
static final String PROPERTY_POINTS
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_LABEL_POS
```
static final String PROPERTY_LABEL_POS
```
    Since:
    
    3.1.175
    
    See Also:
    Constant Field Values
  - PROPERTY_PORT_SOURCE
```
static final String PROPERTY_PORT_SOURCE
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_PORT_TARGET
```
static final String PROPERTY_PORT_TARGET
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_VALUE_NO_PORT
```
static final int PROPERTY_VALUE_NO_PORT
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_VALUE_WEST_PORT
```
static final int PROPERTY_VALUE_WEST_PORT
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_VALUE_EAST_PORT
```
static final int PROPERTY_VALUE_EAST_PORT
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_VALUE_NORTH_PORT
```
static final int PROPERTY_VALUE_NORTH_PORT
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_VALUE_SOUTH_PORT
```
static final int PROPERTY_VALUE_SOUTH_PORT
```
    Since:
    
    3.0
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_SEND
```
static final String PROPERTY_EMAIL_SEND
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_BENEFICIARY
```
static final String PROPERTY_EMAIL_BENEFICIARY
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_TASK_CREATOR
```
static final String PROPERTY_EMAIL_TASK_CREATOR
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_EDITORS
```
static final String PROPERTY_EMAIL_EDITORS
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_LAST_AGENT
```
static final String PROPERTY_EMAIL_LAST_AGENT
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_LIST
```
static final String PROPERTY_EMAIL_LIST
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_SUBJECT
```
static final String PROPERTY_EMAIL_SUBJECT
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_BODY
```
static final String PROPERTY_EMAIL_BODY
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_USER
```
static final String PROPERTY_EMAIL_USER
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - PROPERTY_EMAIL_GROUPS
```
static final String PROPERTY_EMAIL_GROUPS
```
    Since:
    
    3.0.6
    
    See Also:
    Constant Field Values
  - EMAIL_SEND
```
static final int EMAIL_SEND
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - EMAIL_ALLOWED
```
static final int EMAIL_ALLOWED
```
    Since:
    
    3.0.6
    
    See Also:
    Constant Field Values
  - EMAIL_TASK_CREATOR
```
static final int EMAIL_TASK_CREATOR
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - EMAIL_LAST_AGENT
```
static final int EMAIL_LAST_AGENT
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - EMAIL_LIST
```
static final int EMAIL_LIST
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
  - EMAIL_EDITORS
```
static final int EMAIL_EDITORS
```
    Since:
    
    3.0.4
    
    See Also:
    Constant Field Values
- Method Detail
  - getSource
```
@Nullable
WorkflowElement getSource()
```
    Returns the workflow-element this transitions points FROM.
    
    Returns:
    an workflow-element that implements either State or Activity.
    Since:
    
    3.0
  - getTarget
```
@Nullable
WorkflowElement getTarget()
```
    Returns the workflow-element this transitions points TO.
    
    Returns:
    an workflow-element that implements either State or Activity.
    Since:
    
    3.0
  - getAllowedUsers
```
List<String> getAllowedUsers()
```
    Returns all user that are allowed to do this transition.
    
    Returns:
    a list that contains unique user names.
    Since:
    
    3.0
  - getAllowedGroups
```
List<String> getAllowedGroups()
```
    Returns all groups that are allowed to do this transition.
    
    Returns:
    a list that contains unique group names.
    Since:
    
    3.0
  - getNoEditorGroups
```
List<String> getNoEditorGroups()
```
    Groups marked as no editor are not preselected as editor.
    
    Returns:
    List of groups
    Since:
    
    3.0.79
  - getEmailProperty
```
boolean getEmailProperty(int property)
```
    Returns true if this activity has the given property
    
    Parameters:
    property - one of the email properties defined by this interface
    
    Returns:
    true if the given property is correct
    Since:
    
    3.0.4
  - getEmailSubject
```
String getEmailSubject()
```
    Returns the title from the email. Is only valid with email-send property.
    
    Returns:
    the title as a string
    Since:
    
    3.0.4
  - getEmailBody
```
String getEmailBody()
```
    Returns the text from the email. Is only valid with email-send property.
    
    Returns:
    the text as a string
    Since:
    
    3.0.4
  - getEmailUser
```
List<String> getEmailUser()
```
    Returns the user who are selected to be notiefied by mail. Only valid with email-list property.
    
    Returns:
    a list with the selected users
    Since:
    
    3.0.4
  - getEmailGroups
```
List<String> getEmailGroups()
```
    Since:
    
    3.0.6
  - useFixedRights
```
boolean useFixedRights()
```
    Since:
    
    3.0.4
  - useStoreElementRights
```
boolean useStoreElementRights()
```
    Since:
    
    3.0.4
  - getUsedStoreElementRights
```
int getUsedStoreElementRights()
```
    Since:
    
    3.0.4
  - useTaskRights
```
boolean useTaskRights()
```
    Since:
    
    3.0.4
  - getUsedTaskRights
```
int getUsedTaskRights()
```
    Since:
    
    3.0.4

Interface Transition

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

TASK_RIGHT_CREATOR

TASK_RIGHT_LAST_USER

TASK_RIGHT_LAST_ACTION_USER

TASK_RIGHTS

PROPERTY_FIXED_RIGHTS

PROPERTY_STOREELEMENT_RIGHTS

PROPERTY_TASK_RIGHTS

PROPERTY_USED_STOREELEMENT_RIGHT

PROPERTY_USED_TASK_RIGHTS

PROPERTY_USER

PROPERTY_GROUPS

PROPERTY_NO_EDITOR_GROUPS

PROPERTY_POINTS

PROPERTY_LABEL_POS

PROPERTY_PORT_SOURCE

PROPERTY_PORT_TARGET

PROPERTY_VALUE_NO_PORT

PROPERTY_VALUE_WEST_PORT

PROPERTY_VALUE_EAST_PORT

PROPERTY_VALUE_NORTH_PORT

PROPERTY_VALUE_SOUTH_PORT

PROPERTY_EMAIL_SEND

PROPERTY_EMAIL_BENEFICIARY

PROPERTY_EMAIL_TASK_CREATOR

PROPERTY_EMAIL_EDITORS

PROPERTY_EMAIL_LAST_AGENT

PROPERTY_EMAIL_LIST

PROPERTY_EMAIL_SUBJECT

PROPERTY_EMAIL_BODY

PROPERTY_EMAIL_USER

PROPERTY_EMAIL_GROUPS

EMAIL_SEND

EMAIL_ALLOWED

EMAIL_TASK_CREATOR

EMAIL_LAST_AGENT

EMAIL_LIST

EMAIL_EDITORS

Method Detail

getSource

getTarget

getAllowedUsers

getAllowedGroups

getNoEditorGroups

getEmailProperty

getEmailSubject

getEmailBody

getEmailUser

getEmailGroups

useFixedRights

useStoreElementRights

getUsedStoreElementRights

useTaskRights

getUsedTaskRights