Top Description Fields Methods
javax.xml.registry

public Interface BulkResponse

extends JAXRResponse
Imports
java.util.*, javax.xml.registry.infomodel.*

Contains the response of a method in the API that performs a bulk operation and returns a bulk response. Partial commits are allowed on a bulk operation.

In the event of a partial success where only a subset of objects were processed successfully, the getStatus method of the BulkResponse must return JAXRResponse.STATUS_WARNING. In this case, a Collection of JAXRException instances is included in the BulkResponse instance. The JAXRExceptions provide information on each error that prevented some objects in the request to not be processed successfully.

Author
Farrukh S. Najmi
See Also
QueryManager, LifeCycleManager

Field Summary

Inherited from javax.xml.registry.JAXRResponse:
STATUS_FAILURESTATUS_SUCCESSSTATUS_UNAVAILABLESTATUS_WARNING

Method Summary

Modifier and TypeMethod and Description
public Collection<E>

Returns:

Collection of RegistryObject instances. The Collection may be empty but not null.
getCollection
()

Get the Collection of objects returned as a response of a bulk operation.

public Collection<E>

Returns:

Collection of RegistryException instances. Return null if result is available and there is no RegistryException.
getExceptions
()

Get the Collection of RegistryException instances in case of partial commit.

public boolean

Returns:

true if the response is partial; false otherwise
isPartialResponse
()

Determines whether the response is a partial response due to large result set.

Inherited from javax.xml.registry.JAXRResponse:
getRequestIdgetStatusisAvailable

Method Detail

getCollectionback to summary
public Collection<E> getCollection() throws JAXRException

Get the Collection of objects returned as a response of a bulk operation. Caller thread will block here if result is not yet available.

Capability Level: 0
Returns:Collection<E>

Collection of RegistryObject instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.RegistryObject
getExceptionsback to summary
public Collection<E> getExceptions() throws JAXRException

Get the Collection of RegistryException instances in case of partial commit. Caller thread will block here if result is not yet available.

Capability Level: 0
Returns:Collection<E>

Collection of RegistryException instances. Return null if result is available and there is no RegistryException.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
RegistryException
isPartialResponseback to summary
public boolean isPartialResponse() throws JAXRException

Determines whether the response is a partial response due to large result set.

Capability Level: 0
Returns:boolean

true if the response is partial; false otherwise

Exceptions
JAXRException:
If the JAXR provider encounters an internal error