lumis.content.workflow
Class WorkflowTransitionConfig

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

@StableMinor(version="6.1",
             sinceVersion="4.0")
public class WorkflowTransitionConfig
extends java.lang.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 java.lang.String	PARAMETER_NAME
protected java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	permissionsScope

Constructor Summary

WorkflowTransitionConfig(WorkflowStateConfig initialState, org.w3c.dom.Node transitionElement)

Method Summary

java.lang.String	getDescription() Returns the description for this transition.
java.lang.String	getFinalStateId() Returns the identifier for the final state of this transition.
java.lang.String	getId() Returns the identifier for this transition.
java.lang.String	getInitialStateId() Returns the identifier for the initial state of this transition.
WorkflowTransitionConfig.WorkflowLockAction	getLockAction() Returns the lockAction for this transition.
java.lang.String	getName() Returns the name for this transition.
protected java.util.Collection<java.lang.String>	getPermissions(java.lang.Enum<?> scope) Returns all permissions available for a given scope.
java.util.Collection<java.lang.String>	getPermissions(TransitionScope transitionScope) Returns all permissions available for a given scope.
java.util.Collection<java.lang.String>	getPermissionsScopeAll() Deprecated. Since 6.0.2, replaced bygetPermissions(Enum)
java.util.Collection<java.lang.String>	getPermissionsScopeAssignedTo() Deprecated. Since 6.0.2, replaced bygetPermissions(Enum)
protected java.util.EnumSet<TransitionScope>	getScopes() Returns the scopes for a permission object.
protected java.util.Set<java.lang.String>	readPermissionsRoles(org.w3c.dom.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 java.lang.String PARAMETER_NAME

See Also:

Constant Field Values

permissionsScope

protected java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> permissionsScope

Constructor Detail

WorkflowTransitionConfig

public WorkflowTransitionConfig(WorkflowStateConfig initialState,
                                org.w3c.dom.Node transitionElement)
                         throws PortalException

Throws:

PortalException

Method Detail

getInitialStateId

public java.lang.String getInitialStateId()

Returns the identifier for the initial state of this transition.

Returns:

the identifier for the initial state of this transition.

getDescription

public java.lang.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 java.lang.String getFinalStateId()

Returns the identifier for the final state of this transition.

Returns:

the identifier for the final state of this transition.

getName

public java.lang.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 java.lang.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 java.util.Collection<java.lang.String> getPermissionsScopeAll()

Deprecated. Since 6.0.2, replaced bygetPermissions(Enum)

Returns all permissions available for 'all' scope.

Returns:

the permissions for the given scope.

Since:

6.0.2

getPermissionsScopeAssignedTo

@Deprecated
public java.util.Collection<java.lang.String> getPermissionsScopeAssignedTo()

Deprecated. Since 6.0.2, replaced bygetPermissions(Enum)

Returns all permissions available for 'assignedTo' scope.

Returns:

the permissions for the given scope.

Since:

6.0.2

getScopes

protected java.util.EnumSet<TransitionScope> getScopes()

Returns the scopes for a permission object.

Returns:

the scopes.

Since:

6.0.2

getPermissions

public java.util.Collection<java.lang.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 java.util.Set<java.lang.String> readPermissionsRoles(org.w3c.dom.Node[] permissionNodes)
                                                        throws PortalException

Returns an unmodifiable permission roles set.

Parameters:

permissionNodes - the nodes containing the permissions definition.

Throws:

PortalException

getPermissions

protected java.util.Collection<java.lang.String> getPermissions(java.lang.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