Interface ComplexCollectionProcessor
- All Superinterfaces:
Processor
- All Known Subinterfaces:
CountComplexCollectionProcessor
Processor interface for handling a collection of complex-type instances, e.g.,
a property of an entity defined as collection of complex-type instances.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
deleteComplexCollection
(ODataRequest request, ODataResponse response, UriInfo uriInfo) Deletes complex-type collection from an entity and puts the status into the response.void
readComplexCollection
(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat) Reads complex-type collection.void
updateComplexCollection
(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestFormat, ContentType responseFormat) Update (replace) complex-type collection with send data in the persistence and puts content, status, and Location into the response.
-
Method Details
-
readComplexCollection
void readComplexCollection(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat) throws ODataApplicationException, ODataLibraryException Reads complex-type collection. If it is not available, for example due to permissions, the service responds with 404 Not Found.- Parameters:
request
- OData request object containing raw HTTP informationresponse
- OData response object for collecting response datauriInfo
- information of a parsed OData URIresponseFormat
- requested content type after content negotiation- Throws:
ODataApplicationException
- if the service implementation encounters a failureODataLibraryException
-
updateComplexCollection
void updateComplexCollection(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestFormat, ContentType responseFormat) throws ODataApplicationException, ODataLibraryException Update (replace) complex-type collection with send data in the persistence and puts content, status, and Location into the response. Update of complex-type collection is equal to a complete replace of the property (see chapter "11.4.9.4 Update a Collection Property").- Parameters:
request
- OData request object containing raw HTTP informationresponse
- OData response object for collecting response datauriInfo
- information of a parsed OData URIrequestFormat
- content type of body sent with requestresponseFormat
- requested content type after content negotiation- Throws:
ODataApplicationException
- if the service implementation encounters a failureODataLibraryException
-
deleteComplexCollection
void deleteComplexCollection(ODataRequest request, ODataResponse response, UriInfo uriInfo) throws ODataApplicationException, ODataLibraryException Deletes complex-type collection from an entity and puts the status into the response. Deletion for complex-type collection is equal to set the content toEMPTY
.- Parameters:
request
- OData request object containing raw HTTP informationresponse
- OData response object for collecting response datauriInfo
- information of a parsed OData URI- Throws:
ODataApplicationException
- if the service implementation encounters a failureODataLibraryException
-