Package ch.ivyteam.ivy.bpm.engine.client.sub

Class SubSessionChooser

java.lang.Object
ch.ivyteam.ivy.bpm.engine.client.sub.SubSessionChooser
public class SubSessionChooser extends Object
Defines the session that is used to execute the sub process request
Since:
9.2
API:
This is a public API.

  • Method Details

    • user

      public SubRequestBuilder user(String userName)
      Execute the request as user with the given user name
      Parameters:
      userName - name of the user
      Returns:
      request builder for further request construction
      Throws:
      IllegalArgumentException - if user is not found
      API:
      This public API is available in Java.

    • user

      public SubRequestBuilder user(IUser user)
      Execute the request as the given user
      Parameters:
      user -
      Returns:
      request builder for further request construction
      API:
      This public API is available in Java.

    • systemUser

      public SubRequestBuilder systemUser()
      Execute the request as system user
      Returns:
      request builder for further request construction
      API:
      This public API is available in Java.

    • role

      public SubRequestBuilder role(String roleName)
      Execute the request as role with the given role name
      Parameters:
      roleName -
      Returns:
      request builder for further request construction
      API:
      This public API is available in Java.

    • role

      public SubRequestBuilder role(IRole role)
      Execute the request as the given role
      Parameters:
      role -
      Returns:
      request builder for further request construction
      API:
      This public API is available in Java.

    • everybody

      public SubRequestBuilder everybody()
      Execute the request as role Everybody
      Returns:
      request builder for further request construction
      API:
      This public API is available in Java.

    • anonymous

      public SubRequestBuilder anonymous()
      Execute the request as anonymous user
      Returns:
      request builder for further request construction
      API:
      This public API is available in Java.

    • anonymousWithRole

      @Deprecated(since="13.1.0", forRemoval=true) public SubRequestBuilder anonymousWithRole(IRole role)
      Deprecated, for removal: This API element is subject to removal in a future version.
      session roles will be no longer supported in future. use anonymous().
      Execute the request as anonymous session but with the given role assigned
      Returns:
      request builder for further request construction
      See Also:
      API:
      This public API is available in Java.

    • anonymousWithRole

      @Deprecated(since="13.1.0", forRemoval=true) public SubRequestBuilder anonymousWithRole(String roleName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      session roles will be no longer supported in future. use anonymous().
      Execute the request with as anonymous session but with the role assigned given by the role name.
      Parameters:
      roleName - name of the role
      Returns:
      request builder for further request construction
      Throws:
      IllegalArgumentException - if role is not found
      See Also:
      API:
      This public API is available in Java.