org.apache.directory.shared.dsmlv2.reponse
Class BatchResponseDsml

java.lang.Object
  org.apache.directory.shared.dsmlv2.reponse.BatchResponseDsml

public class BatchResponseDsml
extends java.lang.Object

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

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Constructor Summary

BatchResponseDsml()
Creates a new instance of BatchResponseDsml.

Method Summary

boolean	addResponse(DsmlDecorator response) Adds a request to the Batch Response DSML.
int	getRequestID() Gets the ID of the response
boolean	removeResponse(DsmlDecorator response) Removes a request from the Batch Response DSML.
void	setRequestID(int requestID) Sets the ID of the response
java.lang.String	toDsml() Converts the Batch Response 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

BatchResponseDsml

public BatchResponseDsml()

Creates a new instance of BatchResponseDsml.

Method Detail

addResponse

public boolean addResponse(DsmlDecorator response)

Adds a request to the Batch Response DSML.

Parameters:

response - the request to add

Returns:

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

removeResponse

public boolean removeResponse(DsmlDecorator response)

Removes a request from the Batch Response DSML.

Parameters:

response - the request to remove

Returns:

true if this list contained the specified element.

getRequestID

public int getRequestID()

Gets the ID of the response

Returns:

the ID of the response

setRequestID

public void setRequestID(int requestID)

Sets the ID of the response

Parameters:

requestID - the ID to set

toDsml

public java.lang.String toDsml()

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