Package org.apache.olingo.client.core.communication.request.retrieve

Class AbstractODataRetrieveRequest<T>

java.lang.Object

org.apache.olingo.client.core.communication.request.AbstractRequest

org.apache.olingo.client.core.communication.request.AbstractODataRequest

org.apache.olingo.client.core.communication.request.AbstractODataBasicRequest<ODataRetrieveResponse<T>>

org.apache.olingo.client.core.communication.request.retrieve.AbstractODataRetrieveRequest<T>

All Implemented Interfaces:

ODataBasicRequest<ODataRetrieveResponse<T>>, ODataBatchableRequest, ODataRequest, ODataRetrieveRequest<T>

Direct Known Subclasses:

AbstractMetadataRequestImpl, ODataDeltaRequestImpl, ODataEntityRequestImpl, ODataEntitySetIteratorRequestImpl, ODataEntitySetRequestImpl, ODataMediaRequestImpl, ODataPropertyRequestImpl, ODataServiceDocumentRequestImpl, ODataValueRequestImpl

public abstract class AbstractODataRetrieveRequest<T>
extends AbstractODataBasicRequest<ODataRetrieveResponse<T>>
implements ODataRetrieveRequest<T>

This is an abstract representation of an OData retrieve query request returning one or more result item.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractODataRetrieveRequest.AbstractODataRetrieveResponse	Response abstract class about an ODataRetrieveRequest.

Field Summary

Fields inherited from class org.apache.olingo.client.core.communication.request.AbstractODataRequest

httpClient, method, odataClient, odataHeaders, request, uri

Fields inherited from class org.apache.olingo.client.core.communication.request.AbstractRequest

LOG

Constructor Summary

Constructors

Constructor	Description
AbstractODataRetrieveRequest(ODataClient odataClient, URI query)	Private constructor.

Method Summary

Modifier and Type	Method	Description
abstract ODataRetrieveResponse<T>	execute()	Request execute.
InputStream	getPayload()	This kind of request doesn't have any payload: null will be returned.

Methods inherited from class org.apache.olingo.client.core.communication.request.AbstractODataBasicRequest

asyncExecute, batch, batch, setFormat

Methods inherited from class org.apache.olingo.client.core.communication.request.AbstractODataRequest

addCustomHeader, doExecute, getAccept, getContentType, getDefaultFormat, getHeader, getHeader, getHeaderNames, getHttpRequest, getIfMatch, getIfNoneMatch, getMethod, getPrefer, getResponseTemplate, getURI, rawExecute, setAccept, setContentType, setIfMatch, setIfNoneMatch, setPrefer, setURI, setXHTTPMethod, toByteArray

Methods inherited from class org.apache.olingo.client.core.communication.request.AbstractRequest

checkRequest, checkResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.olingo.client.api.communication.request.ODataBasicRequest

asyncExecute, setFormat

Methods inherited from interface org.apache.olingo.client.api.communication.request.ODataBatchableRequest

batch, batch

Methods inherited from interface org.apache.olingo.client.api.communication.request.ODataRequest

addCustomHeader, getAccept, getContentType, getHeader, getHeaderNames, getHttpRequest, getIfMatch, getIfNoneMatch, getMethod, getPrefer, getURI, rawExecute, setAccept, setContentType, setIfMatch, setIfNoneMatch, setPrefer, setURI, setXHTTPMethod, toByteArray

Constructor Details

AbstractODataRetrieveRequest

public AbstractODataRetrieveRequest(ODataClient odataClient,
 URI query)

Private constructor.

Parameters:

odataClient - client instance getting this request

query - query to be executed.

Method Details

execute

public abstract ODataRetrieveResponse<T> execute()

Description copied from interface: ODataBasicRequest

Request execute.

Specified by:

execute in interface ODataBasicRequest<T>

Returns:

return an OData response.

getPayload

public InputStream getPayload()

This kind of request doesn't have any payload: null will be returned.

Specified by:

getPayload in class AbstractODataBasicRequest<ODataRetrieveResponse<T>>

Returns:

InputStream for entire payload.