Package org.eclipse.persistence.jpa.rs.features

Interface FeatureResponseBuilder

All Known Implementing Classes:

FeatureResponseBuilderImpl, PagingResponseBuilder, SelfLinksResponseBuilder

public interface FeatureResponseBuilder

Common interface for all response builders.

Author:

gonural

Method Summary

Modifier and Type	Method	Description
Object	buildAttributeResponse(PersistenceContext context, Map<String,Object> queryParams, String attribute, Object results, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the attribute response.
Object	buildReadAllQueryResponse(PersistenceContext context, Map<String,Object> queryParams, List<Object> items, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the read all query response.
Object	buildReportQueryResponse(PersistenceContext context, Map<String,Object> queryParams, List<Object[]> results, List<org.eclipse.persistence.internal.queries.ReportItem> items, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the report query response.
Object	buildSingleEntityResponse(PersistenceContext context, Map<String,Object> queryParams, Object result, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the single entity response.
Object	buildSingleResultQueryResponse(PersistenceContext context, Map<String,Object> queryParams, Object result, List<org.eclipse.persistence.internal.queries.ReportItem> items, jakarta.ws.rs.core.UriInfo uriInfo)	Builds the single result query response.

Method Detail

buildReadAllQueryResponse

Object buildReadAllQueryResponse(PersistenceContext context,
                                 Map<String,Object> queryParams,
                                 List<Object> items,
                                 jakarta.ws.rs.core.UriInfo uriInfo)

Builds the read all query response.

Parameters:

context - the context

queryParams - the query params

items - the items

uriInfo - the uri info

Returns:

the object

buildReportQueryResponse

Object buildReportQueryResponse(PersistenceContext context,
                                Map<String,Object> queryParams,
                                List<Object[]> results,
                                List<org.eclipse.persistence.internal.queries.ReportItem> items,
                                jakarta.ws.rs.core.UriInfo uriInfo)

Builds the report query response.

Parameters:

context - the context

queryParams - the query params

results - the results

items - the items

uriInfo - the uri info

Returns:

the object

buildSingleEntityResponse

Object buildSingleEntityResponse(PersistenceContext context,
                                 Map<String,Object> queryParams,
                                 Object result,
                                 jakarta.ws.rs.core.UriInfo uriInfo)

Builds the single entity response.

Parameters:

context - the context

queryParams - the query params

result - the result

uriInfo - the uri info

Returns:

the object

buildAttributeResponse

Object buildAttributeResponse(PersistenceContext context,
                              Map<String,Object> queryParams,
                              String attribute,
                              Object results,
                              jakarta.ws.rs.core.UriInfo uriInfo)

Builds the attribute response.

Parameters:

context - the context

queryParams - the query params

attribute - the attribute

results - the results

uriInfo - the uri info

Returns:

the object

buildSingleResultQueryResponse

Object buildSingleResultQueryResponse(PersistenceContext context,
                                      Map<String,Object> queryParams,
                                      Object result,
                                      List<org.eclipse.persistence.internal.queries.ReportItem> items,
                                      jakarta.ws.rs.core.UriInfo uriInfo)

Builds the single result query response.

Parameters:

context - the context

queryParams - the query params

result - the result

items - the report items (result of ReportQuery)

uriInfo - the uri info

Returns:

the response