Class ItemLookupRequest
java.lang.Object
de.hybris.platform.odata2services.odata.persistence.AbstractRequest
de.hybris.platform.odata2services.odata.persistence.CrudRequest
de.hybris.platform.odata2services.odata.persistence.ItemLookupRequest
- All Implemented Interfaces:
ItemSearchRequest
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.odata2services.odata.persistence.CrudRequest
CrudRequest.DataRequestBuilder<T extends CrudRequest.DataRequestBuilder,R extends CrudRequest> Nested classes/interfaces inherited from class de.hybris.platform.odata2services.odata.persistence.AbstractRequest
AbstractRequest.AbstractRequestBuilder<T extends AbstractRequest.AbstractRequestBuilder,R extends AbstractRequest> -
Method Summary
Modifier and TypeMethodDescriptionRetrieves data acceptLocale associated with the request.Deprecated, for removal: This API element is subject to removal in a future version.Specifies conditions the items to retrieve should match.List<org.apache.olingo.odata2.api.uri.NavigationSegment>Specifies conditions the items to retrieve should be ordered byRetrieves pagination specification associated with the item search.Retrieves integration item that contains key attributes of the item to be found.getSkip()Deprecated, for removal: This API element is subject to removal in a future version.use {@link #getPaginationParameters().getPageSize()} method instead.getTop()Deprecated, for removal: This API element is subject to removal in a future version.use {@link #getPaginationParameters().getPageStart()} method instead.@NotNull TypeDescriptorSpecifies the metadata describing the requested item type.booleanSpecifies whether total number of items matching this request should be included in the response or not.booleanSpecifies whether the search response should include number of matching items only.booleantoConversionRequest(ItemModel item) Builds a conversion request with default conversion options from this item lookup requesttoConversionRequest(ItemModel item, ConversionOptions options) Builds a conversion request from this item lookup requestMethods inherited from class de.hybris.platform.odata2services.odata.persistence.CrudRequest
getContentType, getIntegrationKey, getODataEntry, getRequestUri, getServiceRoot, setContentType, setIntegrationItem, setIntegrationKey, setODataEntry, setRequestUri, setServiceRootMethods inherited from class de.hybris.platform.odata2services.odata.persistence.AbstractRequest
getEntitySet, getEntitySetReferencedByProperty, getEntityType, getIntegrationObjectCode, getPropertyTypeName, setAcceptLocale, setEntitySet, setEntityType, setIntegrationObjectCode
-
Method Details
-
getIntegrationItem
- Overrides:
getIntegrationItemin classCrudRequest
-
getSkip
Deprecated, for removal: This API element is subject to removal in a future version.use {@link #getPaginationParameters().getPageSize()} method instead.Retrieves number of items to be skipped in the result set.- Returns:
- requested items will be read from the persistent storage, then, if offset is greater than
0, theoffsetnumber of items at the beginning of the result set will be removed.
-
getTop
Deprecated, for removal: This API element is subject to removal in a future version.use {@link #getPaginationParameters().getPageStart()} method instead.Retrieves number of items to return in the search result.- Returns:
- number of items to be retrieved. The search result may contain fewer number of items or maybe even not items, but it should not contain more items then the page size specified.
-
getPaginationParameters
Description copied from interface:ItemSearchRequestRetrieves pagination specification associated with the item search. If the pagination parameters are present, then items should be retrieved in the page (batch) mode according to that specification. Otherwise, all items should be retrieved.- Specified by:
getPaginationParametersin interfaceItemSearchRequest- Returns:
- an
Optionalcontaining thePaginationParameters, if pagination was specified for this item lookup, or anOptional.empty()otherwise.
-
getTypeDescriptor
Description copied from interface:ItemSearchRequestSpecifies the metadata describing the requested item type.- Specified by:
getTypeDescriptorin interfaceItemSearchRequest- Returns:
- descriptor of an item type within the context integration object, for which data are being requested.
-
getRequestedItem
Description copied from interface:ItemSearchRequestRetrieves integration item that contains key attributes of the item to be found.- Specified by:
getRequestedItemin interfaceItemSearchRequest- Returns:
- a search key represented as an item. If search should be done by an item key, then
IntegrationItemcontaining the key attributes values must be present in this request. However, when search should result in multiple items found, then this method returnsOptional.empty().
-
includeTotalCount
public boolean includeTotalCount()Description copied from interface:ItemSearchRequestSpecifies whether total number of items matching this request should be included in the response or not.- Specified by:
includeTotalCountin interfaceItemSearchRequest- Returns:
true, if the search result must include total number of matching items;false, if the search result needs to contain item(s) only and does not need total count. Keep in mind that requesting total count to be included in the search result may incur performance penalty.
-
getFilter
Description copied from interface:ItemSearchRequestSpecifies conditions the items to retrieve should match.- Specified by:
getFilterin interfaceItemSearchRequest- Returns:
- conditions to be used for searching requested items.
-
getOrderBy
Description copied from interface:ItemSearchRequestSpecifies conditions the items to retrieve should be ordered by- Specified by:
getOrderByin interfaceItemSearchRequest- Returns:
- order by expression list
List<OrderExpression>
-
getAttribute
@Deprecated(since="1905.2002-CEP", forRemoval=true) public org.apache.commons.lang3.tuple.Pair<String,String> getAttribute()Deprecated, for removal: This API element is subject to removal in a future version.since 1905.2002-CEP attribute conditions are converted to filter conditions and therefore can be retrieved bygetFilter()call. -
isNoFilterResult
public boolean isNoFilterResult() -
isCountOnly
public boolean isCountOnly()Description copied from interface:ItemSearchRequestSpecifies whether the search response should include number of matching items only.- Specified by:
isCountOnlyin interfaceItemSearchRequest- Returns:
true, if the search result should contain only count of the matching items but no matching items themselves;false, if the items must be included. Note,trueresult of this call implies thatincludeTotalCount()also returnstrue.
-
getExpand
-
getAcceptLocale
Retrieves data acceptLocale associated with the request.- Specified by:
getAcceptLocalein interfaceItemSearchRequest- Overrides:
getAcceptLocalein classAbstractRequest- Returns:
- a "Accept-Language" header locale associated with the request.
-
toConversionRequest
public ItemConversionRequest toConversionRequest(ItemModel item) throws org.apache.olingo.odata2.api.edm.EdmException Builds a conversion request with default conversion options from this item lookup request- Parameters:
item- an item to be converted to an ODataEntry- Returns:
- an item conversion request built from this item lookup request
- Throws:
org.apache.olingo.odata2.api.edm.EdmException- if underlying EDM is invalid. This is not likely because in such case this request could not be built at the first place
-
toConversionRequest
public ItemConversionRequest toConversionRequest(ItemModel item, ConversionOptions options) throws org.apache.olingo.odata2.api.edm.EdmException Builds a conversion request from this item lookup request- Parameters:
item- an item to be converted to an ODataEntryoptions- conversion options to apply- Returns:
- an item conversion request built from this item lookup request
- Throws:
org.apache.olingo.odata2.api.edm.EdmException- if underlying EDM is invalid. This is not likely because in such case this request could not be built at the first place
-
getFilter()call.