Package org.silverpeas.core.silverstatistics.access.model

Class HistoryCriteria

java.lang.Object

org.silverpeas.core.silverstatistics.access.model.HistoryCriteria

public class HistoryCriteria
extends Object

Class that permits to set search criteria for history statistics.

Author:

silveryocha

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HistoryCriteria.QUERY_ORDER_BY

Constructor Summary

Constructors

Constructor	Description
HistoryCriteria(int actionType)

Method Summary

Modifier and Type	Method	Description
HistoryCriteria	aboutUsers(String... userIds)	Sets the criterion of identifier of users the history must be attached to.
HistoryCriteria	aboutUsers(Collection<String> userIds)	Sets the criterion of identifier of users the history must be attached to.
HistoryCriteria	aboutUsers(Stream<String> userIds)	Sets the criterion of identifier of users the history must be attached to.
HistoryCriteria	byExcludingUsers(String... excludedUserIds)	Sets the criterion of identifier of users the history must not be attached to.
HistoryCriteria	byExcludingUsers(Collection<String> excludedUserIds)	Sets the criterion of identifier of users the history must not be attached to.
HistoryCriteria	byExcludingUsers(Stream<String> excludedUserIds)	Sets the criterion of identifier of users the history must not be attached to.
int	getActionType()
List<String>	getComponentInstanceIds()
List<String>	getExcludedUserIds()
List<HistoryCriteria.QUERY_ORDER_BY>	getOrderByList()
PaginationCriterion	getPagination()
List<String>	getResourceIds()
String	getResourceType()
List<String>	getUserIds()
HistoryCriteria	ofType(String resourceType)	Sets the criterion of resources type the history must be attached.
HistoryCriteria	onResource(ResourceReference resourceReference)	Sets the criterion of resources the history must be attached to.
HistoryCriteria	orderedBy(HistoryCriteria.QUERY_ORDER_BY... orderBies)	Configures the order of the list.
HistoryCriteria	paginatedBy(PaginationPage pagination)	Sets the criteria of pagination.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistoryCriteria

public HistoryCriteria(int actionType)

Method Detail

onResource

public HistoryCriteria onResource(ResourceReference resourceReference)

Sets the criterion of resources the history must be attached to.

Parameters:

resourceReference - the reference of the resource.

Returns:

criteria itself.

ofType

public HistoryCriteria ofType(String resourceType)

Sets the criterion of resources type the history must be attached.

Parameters:

resourceType - the reference of the resource.

Returns:

criteria itself.

aboutUsers

public HistoryCriteria aboutUsers(String... userIds)

Sets the criterion of identifier of users the history must be attached to.

Parameters:

userIds - identifier of users.

Returns:

criteria itself.

aboutUsers

public HistoryCriteria aboutUsers(Collection<String> userIds)

Sets the criterion of identifier of users the history must be attached to.

Parameters:

userIds - identifier of users.

Returns:

criteria itself.

aboutUsers

public HistoryCriteria aboutUsers(Stream<String> userIds)

Sets the criterion of identifier of users the history must be attached to.

Parameters:

userIds - identifier of users.

Returns:

criteria itself.

byExcludingUsers

public HistoryCriteria byExcludingUsers(String... excludedUserIds)

Sets the criterion of identifier of users the history must not be attached to.

Parameters:

excludedUserIds - identifier of users.

Returns:

criteria itself.

byExcludingUsers

public HistoryCriteria byExcludingUsers(Collection<String> excludedUserIds)

Sets the criterion of identifier of users the history must not be attached to.

Parameters:

excludedUserIds - identifier of users.

Returns:

criteria itself.

byExcludingUsers

public HistoryCriteria byExcludingUsers(Stream<String> excludedUserIds)

Sets the criterion of identifier of users the history must not be attached to.

Parameters:

excludedUserIds - identifier of users.

Returns:

criteria itself.

paginatedBy

public HistoryCriteria paginatedBy(PaginationPage pagination)

Sets the criteria of pagination.

Parameters:

pagination - the pagination.

Returns:

criteria itself.

orderedBy

public HistoryCriteria orderedBy(HistoryCriteria.QUERY_ORDER_BY... orderBies)

Configures the order of the list.

Parameters:

orderBies - the list of order by directives.

Returns:

itself.

getActionType

public int getActionType()

getResourceType

public String getResourceType()

getResourceIds

public List<String> getResourceIds()

getComponentInstanceIds

public List<String> getComponentInstanceIds()

getUserIds

public List<String> getUserIds()

getExcludedUserIds

public List<String> getExcludedUserIds()

getPagination

public PaginationCriterion getPagination()

getOrderByList

public List<HistoryCriteria.QUERY_ORDER_BY> getOrderByList()