Package de.espirit.firstspirit.access.store.templatestore

Interface WorkflowTransitionPermission

public interface WorkflowTransitionPermission
Type defining information on permissions for a transition.
Since:
3.0.1

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    allowGroup(Group group)
    Allows the given user group to perform the transition.
    void
    allowUser(User user)
    Allows the given user to perform the transition.
    void
    forbidGroup(Group group)
    Forbids the given user group to perform the transition.
    void
    forbidUser(User user)
    Forbids the given user to perform the transition.
    Group[]
    getAllowedGroups()
    Provides the user groups allowed to perform the transition.
    User[]
    getAllowedUsers()
    Provides the users allowed to perform the transition.
    Transition
    getTransition()
    Provides the transition.
    boolean
    isUserAllowed(User user)
    Ascertains whether the given user is allowed to perform the transition.
    void
    setAllowedGroups(Group[] groups)
    Defines the user groups allowed to perform the transition.
    void
    setAllowedUsers(User[] users)
    Defines the users allowed to perform the transition.

  • Method Details

    • getTransition

      Transition getTransition()
      Provides the transition.
      Returns:
      The transition.
      Since:
      3.0.1

    • getAllowedUsers

      User[] getAllowedUsers()
      Provides the users allowed to perform the transition.
      Returns:
      An array of users.
      Since:
      3.0.1

    • getAllowedGroups

      Group[] getAllowedGroups()
      Provides the user groups allowed to perform the transition.
      Returns:
      An array of groups.
      Since:
      3.0.1

    • forbidUser

      void forbidUser(User user)
      Forbids the given user to perform the transition.
      Parameters:
      user - A user.
      Since:
      3.0.1

    • allowUser

      void allowUser(User user)
      Allows the given user to perform the transition.
      Parameters:
      user - A user.
      Since:
      3.0.1

    • forbidGroup

      void forbidGroup(Group group)
      Forbids the given user group to perform the transition.
      Parameters:
      group - A group.
      Since:
      3.0.1

    • allowGroup

      void allowGroup(Group group)
      Allows the given user group to perform the transition.
      Parameters:
      group - A group.
      Since:
      3.0.1

    • setAllowedUsers

      void setAllowedUsers(User[] users)
      Defines the users allowed to perform the transition.
      Parameters:
      users - An array of users.
      Since:
      3.0.1

    • setAllowedGroups

      void setAllowedGroups(Group[] groups)
      Defines the user groups allowed to perform the transition.
      Parameters:
      groups - An array of groups.
      Since:
      3.0.1

    • isUserAllowed

      boolean isUserAllowed(User user)
      Ascertains whether the given user is allowed to perform the transition.
      Parameters:
      user - A user.
      Returns:
      true, if the user is allowed to perform the transition.
      Since:
      3.0.1