Class WorkflowTransitionConfig


  • @StableMinor(version="16.1",
                 sinceVersion="4.0")
    public class WorkflowTransitionConfig
    extends java.lang.Object
    A transition between two workflow states.
    Since:
    4.0.0
    Version:
    $Revision: 26157 $ $Date: 2024-01-13 11:35:03 -0300 (Sat, 13 Jan 2024) $
    • Field Detail

      • permissionsScope

        protected java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> permissionsScope
    • 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.
      • getPermissionsScopeAll

        @Deprecated
        public java.util.Collection<java.lang.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 java.util.Collection<java.lang.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 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