Package org.fcrepo.search.api
Class SearchParameters
- java.lang.Object
-
- org.fcrepo.search.api.SearchParameters
-
public class SearchParameters extends Object
A pojo encapsulating the parameters of a search- Author:
- dbernstein
-
-
Constructor Summary
Constructors Constructor Description SearchParameters(List<Condition.Field> fields, List<Condition> conditions, int maxResults, int offset, Condition.Field orderBy, String order, boolean includeTotalResultCount)
Constructoor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Condition>
getConditions()
The conditions limiting the searchList<Condition.Field>
getFields()
Returns the list of fields to display in the results.int
getMaxResults()
The max number of results to returnint
getOffset()
The offset (zero-based)String
getOrder()
Returns the order direction (asc or desc) of the results.Condition.Field
getOrderBy()
Returns the field by which to order the results.boolean
isIncludeTotalResultCount()
Returns flag indicating whether or not to include the total result count in the query results.String
toString()
-
-
-
Constructor Detail
-
SearchParameters
public SearchParameters(List<Condition.Field> fields, List<Condition> conditions, int maxResults, int offset, Condition.Field orderBy, String order, boolean includeTotalResultCount)
Constructoor- Parameters:
fields
- The fields to be returned in the resultsconditions
- The conditionsmaxResults
- The max resultsoffset
- The offsetorderBy
- The field by which to order the resultsorder
- The order: ie "asc" or "desc"includeTotalResultCount
- A flag indicating whether or not to return the total result count.
-
-
Method Detail
-
getOffset
public int getOffset()
The offset (zero-based)- Returns:
-
getMaxResults
public int getMaxResults()
The max number of results to return- Returns:
-
getConditions
public List<Condition> getConditions()
The conditions limiting the search- Returns:
-
getFields
public List<Condition.Field> getFields()
Returns the list of fields to display in the results.- Returns:
-
getOrderBy
public Condition.Field getOrderBy()
Returns the field by which to order the results.- Returns:
-
getOrder
public String getOrder()
Returns the order direction (asc or desc) of the results.- Returns:
-
isIncludeTotalResultCount
public boolean isIncludeTotalResultCount()
Returns flag indicating whether or not to include the total result count in the query results.- Returns:
-
-