|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ODataJPAResponseBuilder
The interface provides methods for building an OData response from a JPA Entity. Implement this interface for building an OData response from a JPA Entity.
Method Summary | |
---|---|
ODataResponse |
build(DeleteUriInfo deleteUriInfo,
Object deletedObject)
The method builds an OData response for an OData Delete Request from a deleted JPA Entity |
ODataResponse |
build(GetEntityLinkUriInfo readLinkUriInfo,
Object jpaEntity,
String contentType)
The method builds an OData response for an OData Read Link Request from a read JPA Entity and its related JPA Entities. |
ODataResponse |
build(GetEntitySetLinksUriInfo queryLinkUriInfo,
List<Object> jpaEntity,
String contentType)
The method builds an OData response for an OData Query Link Request from a queried JPA Entity and its related JPA Entities. |
ODataResponse |
build(GetEntitySetUriInfo queryUriInfo,
List<Object> jpaEntities,
String contentType)
The method builds an OData response for an OData Query Request from a queried list of JPA Entities. |
ODataResponse |
build(GetEntityUriInfo readUriInfo,
Object jpaEntity,
String contentType)
The method builds an OData response for an OData Read Request from a read JPA Entity |
ODataResponse |
build(GetFunctionImportUriInfo functionImportUriInfo,
List<Object> resultList,
String contentType)
The method builds an OData response for an OData function Import Request from a registered processor method's return parameter. |
ODataResponse |
build(GetFunctionImportUriInfo functionImportUriInfo,
Object result)
The method builds an OData response for an OData function Import Request from a registered processor method's return parameter. |
ODataResponse |
build(long jpaEntityCount)
The method builds an OData response from a count representing total number of JPA Entities |
ODataResponse |
build(PostUriInfo postUriInfo,
Object createdObject,
String contentType)
The method builds an OData response for an OData Create Request from a created JPA entity. |
ODataResponse |
build(PutMergePatchUriInfo putUriInfo,
Object updatedObject)
The method builds an OData response for an OData Update Request from an updated JPA Entity |
Method Detail |
---|
ODataResponse build(GetEntitySetUriInfo queryUriInfo, List<Object> jpaEntities, String contentType) throws ODataJPARuntimeException
queryUriInfo
- is an information about the request URIjpaEntities
- is an empty or non empty list of queried instances of JPA EntitiescontentType
- of the response
ODataResponse
ODataJPARuntimeException
ODataResponse build(GetEntityUriInfo readUriInfo, Object jpaEntity, String contentType) throws ODataJPARuntimeException, ODataNotFoundException
readUriInfo
- is an information about the request URIjpaEntity
- is a null or non null instances of read JPA EntitycontentType
- of the response
ODataResponse
ODataJPARuntimeException
ODataNotFoundException
ODataResponse build(PostUriInfo postUriInfo, Object createdObject, String contentType) throws ODataJPARuntimeException, ODataNotFoundException
postUriInfo
- is an information about the request URIcreatedObject
- is a null or non null instances of JPA EntitycontentType
- of the response
ODataResponse
ODataJPARuntimeException
ODataNotFoundException
ODataResponse build(PutMergePatchUriInfo putUriInfo, Object updatedObject) throws ODataJPARuntimeException, ODataNotFoundException
putUriInfo
- is an information about the request URIupdatedObject
- is an updated instance of JPA Entity
ODataResponse
ODataJPARuntimeException
ODataNotFoundException
ODataResponse build(DeleteUriInfo deleteUriInfo, Object deletedObject) throws ODataJPARuntimeException, ODataNotFoundException
deleteUriInfo
- is an information about the request URIdeletedObject
- is an null or non null instance of deleted JPA Entity. Null implies Entity not found.
ODataResponse
ODataJPARuntimeException
ODataNotFoundException
ODataResponse build(GetFunctionImportUriInfo functionImportUriInfo, Object result) throws ODataJPARuntimeException
functionImportUriInfo
- is an information about the request URIresult
- is a method's return parameter
ODataResponse
ODataJPARuntimeException
ODataResponse build(GetFunctionImportUriInfo functionImportUriInfo, List<Object> resultList, String contentType) throws ODataJPARuntimeException, ODataNotFoundException
functionImportUriInfo
- is an information about the request URIresult
- is a method's return parameter is a collection of objects.
ODataResponse
ODataJPARuntimeException
ODataNotFoundException
ODataResponse build(GetEntityLinkUriInfo readLinkUriInfo, Object jpaEntity, String contentType) throws ODataNotFoundException, ODataJPARuntimeException
readLinkUriInfo
- is an information about the request URIjpaEntity
- is a null or non null read JPA Entity and its related JPA Entities.contentType
- of the response
ODataResponse
ODataNotFoundException
ODataJPARuntimeException
ODataResponse build(GetEntitySetLinksUriInfo queryLinkUriInfo, List<Object> jpaEntity, String contentType) throws ODataJPARuntimeException
queryLinkUriInfo
- is an information about the request URIjpaEntity
- is an empty or non empty list of queried JPA EntitiescontentType
- of the response
ODataResponse
ODataJPARuntimeException
ODataResponse build(long jpaEntityCount) throws ODataJPARuntimeException
jpaEntityCount
- is the count value
ODataResponse
ODataJPARuntimeException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |