readRequestByRequiredFilter

Facade for sap.apf.core.Request for getting data via the OData protocol. This corresponds to a normal HTTP GET method. Creation is done via APF API. In addition to the handed over filter argument in method send(), the required filters and parameter entity set key properties of the configured entity type are applied, which are determined from path filter.

Constructor Summary

new sap.apf.core.ReadRequestByRequiredFilter(oInject, oRequest, sService, sEntityType)

Method Summary

getMetadataFacade(sService)Returns {sap.apf.core.MetadataFacade} which provides convenience methods for accessing metadata (only for the service document, which is assigned to this read request instance).

send(], fnCallback, oRequestOptions)Executes an OData request.

Constructor Detail

new sap.apf.core.ReadRequestByRequiredFilter(oInject, oRequest, sService, sEntityType)

Parameters:

{object}	oInject	Injection object.
{object}	oInject.instances.coreApi	Instance of core API.
{object}	oInject.instances.oMessageHandler	The APF Message handler.
{object}	oRequest	The object represents an OData GET request.
{string}	sService	Service defined by the analytical content configuration.
{string}	sEntityType	Entity type defined by the analytical content configuration.

Method Detail

getMetadataFacade(sService): sap.apf.core.MetadataFacade

Returns {sap.apf.core.MetadataFacade} which provides convenience methods for accessing metadata (only for the service document, which is assigned to this read request instance).

Parameters:

{string}

sService

Service defined by the request configuration.

Returns:

{sap.apf.core.MetadataFacade}

send(], fnCallback, oRequestOptions)

Executes an OData request.

Parameters:

{sap.apf.utils.Filter}	]	oFilter
{function}	fnCallback	The first argument of the callback function is the received data (as Array). The second argument is {sap.apf.core.EntityTypeMetadata}. The third argument is {sap.apf.core.MessageObject}.
{Object}	oRequestOptions	An optional object containing additional query string options Format: { orderby : [{ property : , order : }], top : , skip : }