Package org.opends.dsml.protocol

Class BatchRequest

java.lang.Object

org.opends.dsml.protocol.BatchRequest

public class BatchRequest
extends Object

Java class for BatchRequest complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="BatchRequest">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="authRequest" type="{urn:oasis:names:tc:DSML:2:0:core}AuthRequest" minOccurs="0"/>
         <group ref="{urn:oasis:names:tc:DSML:2:0:core}BatchRequests" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="requestID" type="{urn:oasis:names:tc:DSML:2:0:core}RequestID" />
       <attribute name="processing" default="sequential">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="sequential"/>
             <enumeration value="parallel"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="responseOrder" default="sequential">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="sequential"/>
             <enumeration value="unordered"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="onError" default="exit">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="resume"/>
             <enumeration value="exit"/>
           </restriction>
         </simpleType>
       </attribute>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthRequest	authRequest
protected List<DsmlMessage>	batchRequests
protected String	onError
protected String	processing
protected String	requestID
protected String	responseOrder

Constructor Summary

Constructors

Constructor	Description
BatchRequest()

Method Summary

Modifier and Type	Method	Description
AuthRequest	getAuthRequest()	Gets the value of the authRequest property.
List<DsmlMessage>	getBatchRequests()	Gets the value of the batchRequests property.
String	getOnError()	Gets the value of the onError property.
String	getProcessing()	Gets the value of the processing property.
String	getRequestID()	Gets the value of the requestID property.
String	getResponseOrder()	Gets the value of the responseOrder property.
void	setAuthRequest(AuthRequest value)	Sets the value of the authRequest property.
void	setOnError(String value)	Sets the value of the onError property.
void	setProcessing(String value)	Sets the value of the processing property.
void	setRequestID(String value)	Sets the value of the requestID property.
void	setResponseOrder(String value)	Sets the value of the responseOrder property.

Methods inherited from class java.lang.Object

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

Field Detail

authRequest

protected AuthRequest authRequest

batchRequests

protected List<DsmlMessage> batchRequests

requestID

protected String requestID

processing

protected String processing

responseOrder

protected String responseOrder

onError

protected String onError

Constructor Detail

BatchRequest

public BatchRequest()

Method Detail

getAuthRequest

public AuthRequest getAuthRequest()

Gets the value of the authRequest property.

Returns:

possible object is AuthRequest

setAuthRequest

public void setAuthRequest(AuthRequest value)

Sets the value of the authRequest property.

Parameters:

value - allowed object is AuthRequest

getBatchRequests

public List<DsmlMessage> getBatchRequests()

Gets the value of the batchRequests property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the batchRequests property.

For example, to add a new item, do as follows:

    getBatchRequests().add(newItem);
 

Objects of the following type(s) are allowed in the list SearchRequest ModifyRequest AddRequest DelRequest ModifyDNRequest CompareRequest AbandonRequest ExtendedRequest

getRequestID

public String getRequestID()

Gets the value of the requestID property.

Returns:

possible object is String

setRequestID

public void setRequestID(String value)

Sets the value of the requestID property.

Parameters:

value - allowed object is String

getProcessing

public String getProcessing()

Gets the value of the processing property.

Returns:

possible object is String

setProcessing

public void setProcessing(String value)

Sets the value of the processing property.

Parameters:

value - allowed object is String

getResponseOrder

public String getResponseOrder()

Gets the value of the responseOrder property.

Returns:

possible object is String

setResponseOrder

public void setResponseOrder(String value)

Sets the value of the responseOrder property.

Parameters:

value - allowed object is String

getOnError

public String getOnError()

Gets the value of the onError property.

Returns:

possible object is String

setOnError

public void setOnError(String value)

Sets the value of the onError property.

Parameters:

value - allowed object is String