| Package | Description |
|---|---|
| uk.co.visalia.brightpearl.apiclient | |
| uk.co.visalia.brightpearl.apiclient.multimessage |
| Modifier and Type | Method and Description |
|---|---|
MultiResponse |
BrightpearlApiClient.execute(AppAuthorisation authorisation,
MultiRequestBuilder multiRequestBuilder)
Convenience method equivalent to
BrightpearlApiClient.execute(AppAuthorisation, MultiRequest), this calls build()
on the supplied builder for executing the request. |
MultiResponse |
BrightpearlLegacyApiSession.execute(MultiRequestBuilder multiRequestBuilder)
Executes a multimessage and returns the parsed responses and error messages.
|
MultiResponse |
BrightpearlApiClient.ApiSession.execute(MultiRequestBuilder multiRequestBuilder)
Convenience method equivalent to
BrightpearlApiClient.ApiSession.execute(MultiRequest), this calls build()
on the supplied builder for executing the request. |
| Modifier and Type | Method and Description |
|---|---|
static MultiRequestBuilder |
MultiRequestBuilder.newMultiRequest()
Returns a new builder instance used to create immutable
MultiRequest instances |
MultiRequestBuilder |
MultiRequestBuilder.withAddedRequest(ServiceWriteRequest request)
Add a request to the multimessage batch.
|
MultiRequestBuilder |
MultiRequestBuilder.withAddedRequest(ServiceWriteRequestBuilder requestBuilder)
Add a request to the multimessage batch.
|
MultiRequestBuilder |
MultiRequestBuilder.withOnFailOption(OnFailOption onFailOption)
Set the on fail option (STOP or CONTINUE) for the request, defining whether remaining requests should still be
executed when one fails.
|
MultiRequestBuilder |
MultiRequestBuilder.withProcessingMode(ProcessingMode processingMode)
Set the processing mode option (SEQUENTIAL or PARALLEL) for the request, which defines whether requests should be
executed in serial or in parallel by the Brightpearl multimessage API.
|
MultiRequestBuilder |
MultiRequestBuilder.withRequests(List<ServiceWriteRequest> requests)
Set the requests to be added to the multimessage batch, replacing any previously set.
|
Copyright © 2014. All Rights Reserved.