org.apache.olingo.client.api.communication.request.retrieve

Interface CommonRetrieveRequestFactory

All Known Subinterfaces:

RetrieveRequestFactory, RetrieveRequestFactory

public interface CommonRetrieveRequestFactory

OData request factory class.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends CommonODataEntity> ODataEntityRequest<T>	getEntityRequest(URI uri) Gets a uri request returning a single OData entity.
<ES extends CommonODataEntitySet,E extends CommonODataEntity> ODataEntitySetIteratorRequest<ES,E>	getEntitySetIteratorRequest(URI uri) Gets a uri request returning a set of one or more OData entities.
<T extends CommonODataEntitySet> ODataEntitySetRequest<T>	getEntitySetRequest(URI uri) Gets a uri request returning a set of one or more OData entities.
ODataMediaRequest	getMediaEntityRequest(URI uri) Gets a uri request returning a media entity.
ODataMediaRequest	getMediaRequest(URI uri) Gets a uri request returning a media stream.
EdmMetadataRequest	getMetadataRequest(String serviceRoot) Gets a metadata request instance.
<T extends CommonODataProperty> ODataPropertyRequest<T>	getPropertyRequest(URI uri) Gets a uri request returning a single OData entity property.
ODataValueRequest	getPropertyValueRequest(URI uri) Gets a uri request returning a single OData entity property value.
ODataRawRequest	getRawRequest(URI uri) Implements a raw request request without specifying any return type.
ODataServiceDocumentRequest	getServiceDocumentRequest(String serviceRoot) Gets a service document request instance.
ODataValueRequest	getValueRequest(URI uri) Gets a uri request returning a single OData entity property value.
XMLMetadataRequest	getXMLMetadataRequest(String serviceRoot) Gets a metadata request instance.

Method Detail

getXMLMetadataRequest

XMLMetadataRequest getXMLMetadataRequest(String serviceRoot)

Gets a metadata request instance.
Compared to getMetadataRequest(java.lang.String), this method returns a request instance for fetching low-level metadata representation.

Parameters:

serviceRoot - absolute URL (schema, host and port included) representing the location of the root of the data service.

Returns:

new XMLMetadataRequest instance.

getMetadataRequest

EdmMetadataRequest getMetadataRequest(String serviceRoot)

Gets a metadata request instance.

Parameters:

serviceRoot - absolute URL (schema, host and port included) representing the location of the root of the data service.

Returns:

new EdmMetadataRequest instance.

getServiceDocumentRequest

ODataServiceDocumentRequest getServiceDocumentRequest(String serviceRoot)

Gets a service document request instance.

Parameters:

serviceRoot - absolute URL (schema, host and port included) representing the location of the root of the data service.

Returns:

new ODataServiceDocumentRequest instance.

getEntitySetRequest

<T extends CommonODataEntitySet> ODataEntitySetRequest<T> getEntitySetRequest(URI uri)

Gets a uri request returning a set of one or more OData entities.

Type Parameters:

T - concrete ODataEntitySet implementation.

Parameters:

uri - request URI.

Returns:

new ODataEntitySetRequest instance.

getEntitySetIteratorRequest

<ES extends CommonODataEntitySet,E extends CommonODataEntity> ODataEntitySetIteratorRequest<ES,E> getEntitySetIteratorRequest(URI uri)

Gets a uri request returning a set of one or more OData entities.
Returned request gives the possibility to consume entities iterating on them without parsing and loading in memory the entire entity set.

Type Parameters:

ES - concreate ODataEntitySet implementation.

E - concrete ODataEntity implementation.

Parameters:

uri - request URI.

Returns:

new ODataEntitySetIteratorRequest instance.

getEntityRequest

<T extends CommonODataEntity> ODataEntityRequest<T> getEntityRequest(URI uri)

Gets a uri request returning a single OData entity.

Type Parameters:

T - concrete ODataEntity implementation.

Parameters:

uri - request URI.

Returns:

new ODataEntityRequest instance.

getPropertyRequest

<T extends CommonODataProperty> ODataPropertyRequest<T> getPropertyRequest(URI uri)

Gets a uri request returning a single OData entity property.

Type Parameters:

T - concrete ODataProperty implementation.

Parameters:

uri - request URI.

Returns:

new ODataPropertyRequest instance.

getPropertyValueRequest

ODataValueRequest getPropertyValueRequest(URI uri)

Gets a uri request returning a single OData entity property value.

Parameters:

uri - request URI.

Returns:

new ODataValueRequest instance.

getValueRequest

ODataValueRequest getValueRequest(URI uri)

Gets a uri request returning a single OData entity property value.

Parameters:

uri - request URI.

Returns:

new ODataValueRequest instance.

getMediaRequest

ODataMediaRequest getMediaRequest(URI uri)

Gets a uri request returning a media stream.

Parameters:

uri - request URI.

Returns:

new ODataMediaRequest instance.

getMediaEntityRequest

ODataMediaRequest getMediaEntityRequest(URI uri)

Gets a uri request returning a media entity.

Parameters:

uri - request URI.

Returns:

new ODataMediaRequest instance.

getRawRequest

ODataRawRequest getRawRequest(URI uri)

Implements a raw request request without specifying any return type.

Parameters:

uri - request URI.

Returns:

new ODataRawRequest instance.