org.apache.directory.shared.dsmlv2.request

Class BatchRequestDsml

java.lang.Object

org.apache.directory.shared.dsmlv2.request.BatchRequestDsml

public class BatchRequestDsml
extends Object

This class represents the Batch Request. It can be used to generate an the XML String of a BatchRequest.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
BatchRequestDsml() Creates a new instance of BatchResponseDsml.

Method Summary

Modifier and Type	Method and Description
boolean	addRequest(DsmlDecorator request) Adds a request to the Batch Request DSML.
BatchRequest.OnError	getOnError() Gets the on error handling type of the request
BatchRequest.Processing	getProcessing() Gets the processing type of the request
int	getRequestID() Gets the ID of the request
BatchRequest.ResponseOrder	getResponseOrder() Gets the reponse order type of the request
boolean	removeRequest(DsmlDecorator request) Removes a request from the Batch Request DSML.
void	setOnError(BatchRequest.OnError onError) Sets the on error handling type of the request
void	setProcessing(BatchRequest.Processing processing) Sets the processing type of the request
void	setRequestID(int requestID) Sets the ID of the request
void	setResponseOrder(BatchRequest.ResponseOrder responseOrder) Sets the reponse order type of the request
String	toDsml() Converts the Batch Request to its XML representation in the DSMLv2 format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchRequestDsml

public BatchRequestDsml()

Creates a new instance of BatchResponseDsml.

Method Detail

addRequest

public boolean addRequest(DsmlDecorator request)

Adds a request to the Batch Request DSML.

Parameters:

request - the request to add

Returns:

true (as per the general contract of the Collection.add method).

removeRequest

public boolean removeRequest(DsmlDecorator request)

Removes a request from the Batch Request DSML.

Parameters:

request - the request to remove

Returns:

true if this list contained the specified element.

getRequestID

public int getRequestID()

Gets the ID of the request

Returns:

the ID of the request

setRequestID

public void setRequestID(int requestID)

Sets the ID of the request

Parameters:

requestID - the ID to set

getProcessing

public BatchRequest.Processing getProcessing()

Gets the processing type of the request

Returns:

the processing type of the request

setProcessing

public void setProcessing(BatchRequest.Processing processing)

Sets the processing type of the request

Parameters:

processing - the processing type to set

getOnError

public BatchRequest.OnError getOnError()

Gets the on error handling type of the request

Returns:

the on error handling type of the request

setOnError

public void setOnError(BatchRequest.OnError onError)

Sets the on error handling type of the request

Parameters:

onError - the on error handling type to set

getResponseOrder

public BatchRequest.ResponseOrder getResponseOrder()

Gets the reponse order type of the request

Returns:

the reponse order type of the request

setResponseOrder

public void setResponseOrder(BatchRequest.ResponseOrder responseOrder)

Sets the reponse order type of the request

Parameters:

responseOrder - the reponse order type to set

toDsml

public String toDsml()

Converts the Batch Request to its XML representation in the DSMLv2 format.