Package ch.ivyteam.ivy.bpm.engine.client
Class RequestBuilder
java.lang.Object
ch.ivyteam.ivy.bpm.engine.client.RequestBuilder
Setups and executes
requests
to run against the IBpmEngine
.- Since:
- 9.1
- API:
- This is a public API.
-
Method Details
-
http
Controls the request method. Per default a process will be executed with HTTP context. You can disable this or start a POST request instead of GET.Example:
bpmClient.start().process(startElement).http().disable().execute(); bpmClient.start().process(startElement).http().post().execute();
- Returns:
- http control access
- API:
- This public API is available in Java.
-
withParam
Add start parameters for the chosen process.Example:
bpmClient.start().process(startElement).withParam("name", "value").execute();
- Parameters:
name
-value
-- Returns:
- request builder for further request construction
- API:
- This public API is available in Java.
-
as
Defines the session that is used to execute the requestExample:
bpmClient.start().process(startElement).as().user("test").execute();
- Returns:
- session chooser access
- API:
- This public API is available in Java.
-
execute
Executes a defined bpm process.Example:
bpmClient.start().process(startElement).execute();
- Returns:
- execution result
- API:
- This public API is available in Java.
-
executeAndIgnoreBpmError
Executes a defined bpm process and ignores all bpm errors. UseExecutionResult.bpmError()
to assert a bpm error that was thrown by the process. Useexecute()
if you don't want to ignore bpm errors.Example:
bpmClient.start().process(startElement).executeAndIgnoreBpmError();
- Returns:
- execution result
- See Also:
- API:
- This public API is available in Java.
-