lumis.content.workflow
Class WorkflowTransitionConfig

java.lang.Object
  lumis.content.workflow.WorkflowTransitionConfig

@StableMinor(version="6.2",
             sinceVersion="4.0")
public class WorkflowTransitionConfig
extends Object

A transition between two workflow states.

Since:

4.0.0

Nested Class Summary

static class

WorkflowTransitionConfig.WorkflowLockAction Defines the possible actions that should be taken regarding lock in the ContentLocale.

Field Summary

static String	PARAMETER_NAME
protected Map<String,Collection<String>>	permissionsScope

Constructor Summary

WorkflowTransitionConfig(WorkflowStateConfig initialState, Node transitionElement)

Method Summary

String	getDescription() Returns the description for this transition.
String	getFinalStateId() Returns the identifier for the final state of this transition.
String	getId() Returns the identifier for this transition.
String	getInitialStateId() Returns the identifier for the initial state of this transition.
WorkflowTransitionConfig.WorkflowLockAction	getLockAction() Returns the lockAction for this transition.
String	getName() Returns the name for this transition.
protected Collection<String>	getPermissions(Enum<?> scope) Returns all permissions available for a given scope.
Collection<String>	getPermissions(TransitionScope transitionScope) Returns all permissions available for a given scope.
Collection<String>	getPermissionsScopeAll() Deprecated. Since 6.0.2, replaced by getPermissions(TransitionScope).
Collection<String>	getPermissionsScopeAssignedTo() Deprecated. Since 6.0.2, replaced by getPermissions(TransitionScope).
protected EnumSet<TransitionScope>	getScopes() Returns the scopes for a permission object.
protected Set<String>	readPermissionsRoles(Node[] permissionNodes) Returns an unmodifiable permission roles set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAMETER_NAME

public static final String PARAMETER_NAME

See Also:

Constant Field Values

permissionsScope

protected Map<String,Collection<String>> permissionsScope

Constructor Detail

WorkflowTransitionConfig

public WorkflowTransitionConfig(WorkflowStateConfig initialState,
                                Node transitionElement)
                         throws PortalException

Throws:

PortalException

Method Detail

getInitialStateId

public String getInitialStateId()

Returns the identifier for the initial state of this transition.

Returns:

the identifier for the initial state of this transition.

getDescription

public String getDescription()

Returns the description for this transition.

Returns:

this transition's description, localizable using its workflow's string resource, or null if not defined.

See Also:

WorkflowConfig.getResource()

getFinalStateId

public String getFinalStateId()

Returns the identifier for the final state of this transition.

Returns:

the identifier for the final state of this transition.

getName

public String getName()

Returns the name for this transition.

Returns:

this transition's name, localizable using its workflow's string resource.

See Also:

WorkflowConfig.getResource()

getId

public String getId()

Returns the identifier for this transition.

Returns:

the identifier for this transition.

getLockAction

public WorkflowTransitionConfig.WorkflowLockAction getLockAction()

Returns the lockAction for this transition.

Returns:

the lockAction for this transition.

Since:

6.0.0

getPermissionsScopeAll

@Deprecated
public Collection<String> getPermissionsScopeAll()

Deprecated. Since 6.0.2, replaced by getPermissions(TransitionScope).

Returns all permissions available for 'all' scope.

Returns:

the permissions for the given scope.

Since:

6.0.2

getPermissionsScopeAssignedTo

@Deprecated
public Collection<String> getPermissionsScopeAssignedTo()

Deprecated. Since 6.0.2, replaced by getPermissions(TransitionScope).

Returns all permissions available for 'assignedTo' scope.

Returns:

the permissions for the given scope.

Since:

6.0.2

getScopes

protected EnumSet<TransitionScope> getScopes()

Returns the scopes for a permission object.

Returns:

the scopes.

Since:

6.0.2

getPermissions

public Collection<String> getPermissions(TransitionScope transitionScope)

Returns all permissions available for a given scope.

Parameters:

transitionScope - the scope to have the permissions returned

Returns:

the permissions

Since:

6.0.2

readPermissionsRoles

protected Set<String> readPermissionsRoles(Node[] permissionNodes)
                                    throws PortalException

Returns an unmodifiable permission roles set.

Parameters:

permissionNodes - the nodes containing the permissions definition.

Throws:

PortalException

getPermissions

protected Collection<String> getPermissions(Enum<?> scope)

Returns all permissions available for a given scope.

Parameters:

scope - the scope to have the permissions returned

Returns:

the permissions

Since:

6.0.2