Interface ItemSearchRequest
- All Known Implementing Classes:
ImmutableItemSearchRequest,ItemLookupRequest
public interface ItemSearchRequest
Describes request for searching item(s) existing in the platform.
-
Method Summary
Modifier and TypeMethodDescriptiondefault LocaleGet accepted locale extracted from the "Accept-Language" header locale associated with the request.Specifies conditions the items to retrieve should match.default List<OrderExpression>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.@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.
-
Method Details
-
getPaginationParameters
Optional<PaginationParameters> getPaginationParameters()Retrieves 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.- Returns:
- an
Optionalcontaining thePaginationParameters, if pagination was specified for this item lookup, or anOptional.empty()otherwise.
-
getTypeDescriptor
Specifies the metadata describing the requested item type.- Returns:
- descriptor of an item type within the context integration object, for which data are being requested.
-
getRequestedItem
Optional<IntegrationItem> getRequestedItem()Retrieves integration item that contains key attributes of the item to be found.- 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().
-
getFilter
WhereClauseConditions getFilter()Specifies conditions the items to retrieve should match.- Returns:
- conditions to be used for searching requested items.
-
includeTotalCount
boolean includeTotalCount()Specifies whether total number of items matching this request should be included in the response or not.- 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.
-
isCountOnly
boolean isCountOnly()Specifies whether the search response should include number of matching items only.- 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.
-
getOrderBy
Specifies conditions the items to retrieve should be ordered by- Returns:
- order by expression list
List<OrderExpression>
-
getAcceptLocale
Get accepted locale extracted from the "Accept-Language" header locale associated with the request.- Returns:
- accepted locale
Locale
-