public class BatchRequestDsml extends Object
Modifier and Type | Class and Description |
---|---|
static class |
BatchRequestDsml.OnError
This enum represents the different types of on error handling for a BatchRequest
|
static class |
BatchRequestDsml.Processing
This enum represents the different types of processing for a Batch Request
|
static class |
BatchRequestDsml.ResponseOrder
This enum represents the different types of response order for a Batch Request
|
Constructor and Description |
---|
BatchRequestDsml()
Creates a new instance of BatchResponseDsml.
|
Modifier and Type | Method and Description |
---|---|
boolean |
addRequest(DsmlDecorator<? extends Request> request)
Adds a request to the Batch Request DSML.
|
DsmlDecorator<? extends Request> |
getCurrentRequest()
Gets the current request
|
BatchRequestDsml.OnError |
getOnError()
Gets the on error handling type of the request
|
BatchRequestDsml.Processing |
getProcessing()
Gets the processing type of the request
|
int |
getRequestID()
Gets the ID of the request
|
List<DsmlDecorator<? extends Request>> |
getRequests()
Gets the List of all the requests in the Batch Request
|
BatchRequestDsml.ResponseOrder |
getResponseOrder()
Gets the response order type of the request
|
boolean |
isStoringRequests() |
boolean |
removeRequest(DsmlDecorator<? extends Request> request)
Removes a request from the Batch Request DSML.
|
void |
setOnError(BatchRequestDsml.OnError onError)
Sets the on error handling type of the request
|
void |
setProcessing(BatchRequestDsml.Processing processing)
Sets the processing type of the request
|
void |
setRequestID(int requestID)
Sets the ID of the request
|
void |
setResponseOrder(BatchRequestDsml.ResponseOrder responseOrder)
Sets the response order type of the request
|
void |
setStoreReq(boolean storeReq)
set the storeReq flag to turn on/off storing of request objects
Note: it is better to set this flag to false while processing large DSML
batch requests
|
String |
toDsml()
Converts this Batch Request to its XML representation in the DSMLv2 format.
|
String |
toString() |
public BatchRequestDsml()
public DsmlDecorator<? extends Request> getCurrentRequest()
public boolean addRequest(DsmlDecorator<? extends Request> request)
request
- the request to addpublic boolean removeRequest(DsmlDecorator<? extends Request> request)
request
- the request to removepublic int getRequestID()
public void setRequestID(int requestID)
requestID
- the ID to setpublic BatchRequestDsml.Processing getProcessing()
public void setProcessing(BatchRequestDsml.Processing processing)
processing
- the processing type to setpublic BatchRequestDsml.OnError getOnError()
public void setOnError(BatchRequestDsml.OnError onError)
onError
- the on error handling type to setpublic BatchRequestDsml.ResponseOrder getResponseOrder()
public void setResponseOrder(BatchRequestDsml.ResponseOrder responseOrder)
responseOrder
- the response order type to setpublic List<DsmlDecorator<? extends Request>> getRequests()
public String toDsml()
public boolean isStoringRequests()
public void setStoreReq(boolean storeReq)
storeReq
- Tells if the request objects must be stored or notCopyright © 2003–2018 The Apache Software Foundation. All rights reserved.