Class DocumentActivityQuery
- java.lang.Object
-
- com.comalatech.workflow.model.document.activity.DocumentActivityQuery
-
public class DocumentActivityQuery extends Object
Query object to search for document activities usingDocumentActivityService
- Since:
- 7.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_RESULTS_LIMIT
-
Constructor Summary
Constructors Constructor Description DocumentActivityQuery()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentActivityQueryFilter
getFilters()
Retrieves the filters objectint
getLimit()
Retrieves the limit of the amount of activities, by default is 100int
getOffset()
Retrieves the offset of the query, by default is 0SortingOrder
getOrder()
Retrieves the sorting orderSortingOrder
for the datavoid
setFilters(DocumentActivityQueryFilter filters)
Filter by particular fields and types of activitiesvoid
setLimit(int limit)
Sets the limit for the amount of activities retrievedvoid
setOffset(int offset)
Sets the offset used to paginate results within a certain queryvoid
setOrder(SortingOrder order)
Sets the sorting order for the results
-
-
-
Field Detail
-
DEFAULT_RESULTS_LIMIT
public static final int DEFAULT_RESULTS_LIMIT
- See Also:
- Constant Field Values
-
-
Method Detail
-
getOrder
public SortingOrder getOrder()
Retrieves the sorting orderSortingOrder
for the data- Returns:
- the sorting order by default is desc
- Since:
- 7.0
-
setOrder
public void setOrder(SortingOrder order)
Sets the sorting order for the results- Parameters:
order
-SortingOrder
asc/desc- Since:
- 7.0
-
getOffset
public int getOffset()
Retrieves the offset of the query, by default is 0- Returns:
- the offset of the query
- Since:
- 7.0
-
setOffset
public void setOffset(int offset)
Sets the offset used to paginate results within a certain query- Parameters:
offset
- next activity element to retrieve by the query. Independent of the dates filters inDocumentActivityQueryFilter
, this fields allows to iterate/paginate through the results of the search- Since:
- 7.0
-
getLimit
public int getLimit()
Retrieves the limit of the amount of activities, by default is 100- Returns:
- the number of the maximum amount of activities
- Since:
- 7.0
-
setLimit
public void setLimit(int limit)
Sets the limit for the amount of activities retrieved- Parameters:
limit
- the max number of results. default is 100.- Since:
- 7.0
-
getFilters
public DocumentActivityQueryFilter getFilters()
Retrieves the filters object- Returns:
- the filters object
DocumentActivityQueryFilter
- Since:
- 7.0
-
setFilters
public void setFilters(DocumentActivityQueryFilter filters)
Filter by particular fields and types of activities- Parameters:
filters
- objectDocumentActivityQueryFilter
for detailed querying- Since:
- 7.0
-
-