Package com.comalatech.workflow.model.document.activity

Interface DocumentActivityQuery

public interface DocumentActivityQuery

Query object to search for document activities using DocumentActivityService

Since:

7.0

Method Summary

Modifier and Type	Method	Description
DocumentActivityQueryFilter	getFilters()	Retrieves the object filter
int	getLimit()	Retrieves the limit of the amount of activities
int	getOffset()	Retrieves the offset of the query
SortingOrder	getOrder()	Retrieves the sorting order SortingOrder for the data
void	setFilters(DocumentActivityQueryFilter filters)	Filter by particular fields and types of activities
void	setLimit(int limit)	Limits the maximum amount of activities retrieved
void	setOffset(int offset)	Offset used to paginate results within a certain query
void	setOrder(SortingOrder order)	Order for the results

Method Detail

getOrder

SortingOrder getOrder()

Retrieves the sorting order SortingOrder for the data

Returns:

the sorting order by default is desc

Since:

7.0

setOrder

void setOrder(SortingOrder order)

Order for the results

Parameters:

order - SortingOrder asc/desc

Since:

7.0

getOffset

int getOffset()

Retrieves the offset of the query

Returns:

the offset of the query by default is 0

Since:

7.0

setOffset

void setOffset(int offset)

Offset used to paginate results within a certain query

Parameters:

offset - next activity element to retrieve by the query. Independent of the dates filters in DocumentActivityQueryFilter, this fields allows to iterate/paginate through the results of the search

Since:

7.0

getLimit

int getLimit()

Retrieves the limit of the amount of activities

Returns:

the number of the maximum amount of activities by default is 100

Since:

7.0

setLimit

void setLimit(int limit)

Limits the maximum amount of activities retrieved

Parameters:

limit - the max number of results. default is 100.

Since:

7.0

getFilters

DocumentActivityQueryFilter getFilters()

Retrieves the object filter

Returns:

the object filter DocumentActivityQueryFilter

Since:

7.0

setFilters

void setFilters(DocumentActivityQueryFilter filters)

Filter by particular fields and types of activities

Parameters:

filters - object DocumentActivityQueryFilter for detailed querying

Since:

7.0