org.apache.directory.shared.dsmlv2.request

Class BatchRequest

java.lang.Object

org.apache.directory.shared.dsmlv2.request.BatchRequest

public class BatchRequest
extends Object

This class represents the Batch Request of a DSML Request

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchRequest.OnError This enum represents the different types of on error handling for a BatchRequest
static class	BatchRequest.Processing This enum represents the different types of processing for a Batch Request
static class	BatchRequest.ResponseOrder This enum represents the different types of response order for a Batch Request

Constructor Summary

Constructors

Constructor and Description
BatchRequest() Creates a new instance of BatchRequest.

Method Summary

Modifier and Type	Method and Description
boolean	addRequest(LdapMessageCodec request) Adds a request
LdapMessageCodec	getCurrentRequest() Gets the current request
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
List	getRequests() Gets the List of all the requests in the Batch Request
BatchRequest.ResponseOrder	getResponseOrder() Gets the reponse order type of the request
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	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchRequest

public BatchRequest()

Creates a new instance of BatchRequest.

Method Detail

addRequest

public boolean addRequest(LdapMessageCodec request)

Adds a request

Parameters:

request - the resquest to add

Returns:

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

getCurrentRequest

public LdapMessageCodec getCurrentRequest()

Gets the current request

Returns:

the current request

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

getRequests

public List getRequests()

Gets the List of all the requests in the Batch Request

Returns:

the List of all the requests in the Batch Request

toString

public String toString()

Overrides:

toString in class Object