Package ch.ivyteam.ivy.workflow.task

Interface IActivator

public interface IActivator

An activator is a user or a role that can start a task.

Read more about this activator in the designer guide at task switch process element.

Since:
8.0.3
API:
This is a public API.

  • Method Details

    • get

      ISecurityMember get()

      Gets the task activator's user or a role.

      May return null if the activator was deleted since the creation of the task or was not defined at all (e.g. expiry task activator is optional)

      Note, that the method name() may return a valid name even if the task activator was deleted.

      Returns:
      user or role or null if activator was not defined or was deleted
      See Also:
      API:
      This public API is available in Java.

    • set

      void set(ISecurityMember activator)
      Sets the task activator
      Parameters:
      activator - either a user or a role
      API:
      This public API is available in Java.

    • name

      String name()
      Get the name of the task activator. Maybe null if the task activator was not defined (e.g. expiry task activator). Returns a valid name even if the task activator was defined but was deleted in the meantime.
      Returns:
      task activator name or null.
      API:
      This public API is available in Java.

    • displayName

      String displayName()
      Get the display name of the task activator. Maybe null if the task activator was not defined (e.g. expiry task activator). Returns a valid name even if the task activator was defined but was deleted in the meantime.
      Returns:
      task activator name or null.
      API:
      This public API is available in Java.

    • userCandidatesPaged

      IPagedIterable<IUser> userCandidatesPaged()

      Evaluates all users who can resume this task. If the activator is a role, then all users that own this role will be included in the list. In case some users are absent, their substitutes will be included as well. However substitutes of substitutes are not included.

      This method uses a default, system defined page size (1000) which does not harm memory and provides still good performance.

      Returns:
      user candidates
      See Also:
      API:
      This public API is available in Java.

    • userCandidatesPaged

      IPagedIterable<IUser> userCandidatesPaged(int pageSize)
      Evaluates all users who can resume this task. If the activator is a role, then all users that own this role will be included in the list. In case some users are absent, their substitutes will be included as well. However substitutes of substitutes are not included.
      Parameters:
      pageSize - the maximum number of users loaded at once into memory On paged UI tables the number of objects you display on a single page.
      Returns:
      user candidates
      See Also:
      API:
      This public API is available in Java.

    • available

      boolean available()
      Whether the activator is set and in case of a user is enabled.
      Returns:
      true if its available otherwise false.
      Since:
      9.1
      API:
      This public API is available in Java.

    • isUser

      boolean isUser(IUser user)
      Whether the activator is set and is the given user.
      Parameters:
      user - the user to test
      Returns:
      true if activator is the given user.
      Since:
      9.1
      API:
      This public API is available in Java.

    • isUser

      boolean isUser()
      Whether the activator is set and is a user
      Returns:
      true if activator is a user
      API:
      This public API is available in Java.

    • isSystemUser

      boolean isSystemUser()
      Whether the activator is set and is the System user.
      Returns:
      true if activator is the system user.
      Since:
      9.1
      API:
      This public API is available in Java.

    • isRole

      boolean isRole(IRole role)
      Whether the activator is set and is the given role.
      Parameters:
      role - the role to test
      Returns:
      true if activator is the system user.
      Since:
      9.1
      API:
      This public API is available in Java.

    • isRole

      boolean isRole()
      Whether the activator is set and is a role.
      Returns:
      true if activator is a role.
      Since:
      9.1
      API:
      This public API is available in Java.

    • isMember

      boolean isMember(IUserToken userToken)
      Whether the activator is set and the given user token is a member of the activator.
      Parameters:
      userToken - the user token to test
      Returns:
      true if the given user token is a member of the activator.
      Since:
      9.1
      API:
      This public API is available in Java.