Interface IUserInvocationTriggerBuilder

All Superinterfaces:
IBaseTriggerPropsBuilder<IUserInvocationTriggerBuilder, FcUserInvocationProps>, IWorkflowElementBuilder<WorkflowTrigger, FcUserInvocationProps>
public interface IUserInvocationTriggerBuilder extends IBaseTriggerPropsBuilder<IUserInvocationTriggerBuilder, FcUserInvocationProps>
A builder for a new event of type EWorkflowTriggerType.FC_USER_INVOCATION that occurs when a portal user initiates it.
Since:
8.2.0

  • Method Details

    • displayName

      IUserInvocationTriggerBuilder displayName(Locale locale, String displayName)
      Sets the display name of the trigger in a specific locale.
      Parameters:
      locale - The locale.
      displayName - The display name.
      Returns:
      This builder for chaining method calls.

    • userGroup

      IUserInvocationTriggerBuilder userGroup(BenutzerGruppe userGroup)
      Adds a user group to the list of groups that is allowed to initiate the trigger. When no group is set, no restriction is applied.
      Parameters:
      userGroup - A user group to add.
      Returns:
      This builder for chaining method calls.

    • accessType

      IUserInvocationTriggerBuilder accessType(EUserInvocationAccessType accessType)
      Sets the access type of the trigger. This determines which users are allowed to initiate the trigger.
      Parameters:
      accessType - The access type of the trigger.
      Returns:
      This builder for chaining method calls.

    • userGroups

      default IUserInvocationTriggerBuilder userGroups(BenutzerGruppe... userGroups)
      Adds user groups to the list of groups that is allowed to initiate the trigger. When no group is set, no restriction is applied.
      Parameters:
      userGroups - User groups to add.
      Returns:
      This builder for chaining method calls.

    • userGroups

      default IUserInvocationTriggerBuilder userGroups(Iterable<BenutzerGruppe> userGroups)
      Adds user groups to the list of groups that is allowed to initiate the trigger. When no group is set, no restriction is applied.
      Parameters:
      userGroups - User groups to add.
      Returns:
      This builder for chaining method calls.

    • workflowState

      IUserInvocationTriggerBuilder workflowState(WorkflowState state)
      Adds a workflow state to the list of state a form record must have for the trigger to be initiated. When no state is set, no restriction is applied.
      Parameters:
      state - A workflow state to add.
      Returns:
      This builder for chaining method calls.

    • workflowStates

      default IUserInvocationTriggerBuilder workflowStates(WorkflowState... states)
      Adds workflow states to the list of state a form record must have for the trigger to be initiated. When no state is set, no restriction is applied.
      Parameters:
      states - Workflow states to add.
      Returns:
      This builder for chaining method calls.

    • workflowStates

      default IUserInvocationTriggerBuilder workflowStates(Iterable<WorkflowState> states)
      Adds workflow states to the list of state a form record must have for the trigger to be initiated. When no state is set, no restriction is applied.
      Parameters:
      states - Workflow states to add.
      Returns:
      This builder for chaining method calls.