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 and Description
java.lang.Object	buildAttributeResponse(PersistenceContext context, java.util.Map<java.lang.String,java.lang.Object> queryParams, java.lang.String attribute, java.lang.Object results, javax.ws.rs.core.UriInfo uriInfo) Builds the attribute response.
java.lang.Object	buildReadAllQueryResponse(PersistenceContext context, java.util.Map<java.lang.String,java.lang.Object> queryParams, java.util.List<java.lang.Object> items, javax.ws.rs.core.UriInfo uriInfo) Builds the read all query response.
java.lang.Object	buildReportQueryResponse(PersistenceContext context, java.util.Map<java.lang.String,java.lang.Object> queryParams, java.util.List<java.lang.Object[]> results, java.util.List<org.eclipse.persistence.internal.queries.ReportItem> items, javax.ws.rs.core.UriInfo uriInfo) Builds the report query response.
java.lang.Object	buildSingleEntityResponse(PersistenceContext context, java.util.Map<java.lang.String,java.lang.Object> queryParams, java.lang.Object result, javax.ws.rs.core.UriInfo uriInfo) Builds the single entity response.
java.lang.Object	buildSingleResultQueryResponse(PersistenceContext context, java.util.Map<java.lang.String,java.lang.Object> queryParams, java.lang.Object result, java.util.List<org.eclipse.persistence.internal.queries.ReportItem> items, javax.ws.rs.core.UriInfo uriInfo) Builds the single result query response.

Method Detail

buildReadAllQueryResponse

java.lang.Object buildReadAllQueryResponse(PersistenceContext context,
                                           java.util.Map<java.lang.String,java.lang.Object> queryParams,
                                           java.util.List<java.lang.Object> items,
                                           javax.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

java.lang.Object buildReportQueryResponse(PersistenceContext context,
                                          java.util.Map<java.lang.String,java.lang.Object> queryParams,
                                          java.util.List<java.lang.Object[]> results,
                                          java.util.List<org.eclipse.persistence.internal.queries.ReportItem> items,
                                          javax.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

java.lang.Object buildSingleEntityResponse(PersistenceContext context,
                                           java.util.Map<java.lang.String,java.lang.Object> queryParams,
                                           java.lang.Object result,
                                           javax.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

java.lang.Object buildAttributeResponse(PersistenceContext context,
                                        java.util.Map<java.lang.String,java.lang.Object> queryParams,
                                        java.lang.String attribute,
                                        java.lang.Object results,
                                        javax.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

java.lang.Object buildSingleResultQueryResponse(PersistenceContext context,
                                                java.util.Map<java.lang.String,java.lang.Object> queryParams,
                                                java.lang.Object result,
                                                java.util.List<org.eclipse.persistence.internal.queries.ReportItem> items,
                                                javax.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