Package io.constructor.client
Class BrowseItemsRequest
java.lang.Object
io.constructor.client.BrowseItemsRequest
Constructor.io Browse Items Request
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetIds()
int
getPage()
int
boolean
void
void
setFilterMatchTypes
(Map<String, String> filterMatchTypes) void
setFormatOptions
(Map<String, String> formatOptions) void
setGroupId
(String groupId) void
setHiddenFacets
(List<String> hiddenFacets) void
setHiddenFields
(List<String> hiddenFields) void
void
setPage
(int page) void
setResultsPerPage
(int resultsPerPage) void
setSection
(String section) void
setSortAscending
(boolean sortAscending) void
-
Constructor Details
-
BrowseItemsRequest
Creates a browse request- Parameters:
ids
- the items to return browse results for- Throws:
IllegalArgumentException
-
-
Method Details
-
setIds
- Parameters:
ids
- the item ID's to set
-
getIds
- Returns:
- the item ID's
-
getSection
- Returns:
- the section
-
setSection
- Parameters:
section
- the section to set
-
getPage
public int getPage()- Returns:
- the page
-
setPage
public void setPage(int page) - Parameters:
page
- the page to set
-
getResultsPerPage
public int getResultsPerPage()- Returns:
- the resultsPerPage
-
setResultsPerPage
public void setResultsPerPage(int resultsPerPage) - Parameters:
resultsPerPage
- the resultsPerPage to set
-
getGroupId
- Returns:
- the groupId
-
setGroupId
- Parameters:
groupId
- the groupId to set
-
setFacets
- Parameters:
facets
- the facets to set
-
getFacets
- Returns:
- the facets
-
setSortBy
- Parameters:
sortBy
- the sortBy to set
-
getSortBy
- Returns:
- the sortBy
-
setSortAscending
public void setSortAscending(boolean sortAscending) - Parameters:
sortAscending
- the sortAscending to set
-
getSortAscending
public boolean getSortAscending()- Returns:
- the sortAscending
-
setFormatOptions
- Parameters:
formatOptions
- the formatOptions to set
-
getFormatOptions
- Returns:
- the format options
-
setHiddenFields
- Parameters:
hiddenFields
- the hiddenFields to set
-
getHiddenFields
- Returns:
- the hidden fields
-
setHiddenFacets
- Parameters:
hiddenFacets
- the hiddenFacets to set
-
getHiddenFacets
- Returns:
- the hidden facets
-
setFilterMatchTypes
- Parameters:
filterMatchTypes
- the filterMatchTypes to set. Please refer to https://docs.constructor.com/reference/v1-browse-get-browse-items-results for details Possible values 'all', 'any' or 'none'
-
getFilterMatchTypes
- Returns:
- the filterMatchTypes
-