com.atlassian.crowd.search.query

Class AuditQuery

java.lang.Object

com.atlassian.crowd.search.query.entity.EntityQuery<AuditLogChangeset>

com.atlassian.crowd.search.query.AuditQuery

All Implemented Interfaces:

Query<AuditLogChangeset>

public class AuditQuery
extends EntityQuery<AuditLogChangeset>

Specialized class for Audit log queries. Provides additional support for custom ordering and determining sort direction. By default the sort direction is descending.

Since:

2.12.0

Field Summary

Fields inherited from class com.atlassian.crowd.search.query.entity.EntityQuery

ALL_RESULTS, MAX_MAX_RESULTS

Constructor Summary

Constructors

Constructor and Description
AuditQuery(EntityQuery query)
AuditQuery(EntityQuery<AuditLogChangeset> query, int startIndex, int maxResults)
AuditQuery(SearchRestriction searchRestriction, int startIndex, int maxResults)

Method Summary

Modifier and Type	Method and Description
String	getOrderBy()
Class<AuditLogChangeset>	getReturnType() The type of elements to return.
boolean	isDescending()
void	setDescending(boolean descending) Sets the ordering type in the query - descending or ascending
void	setOrderBy(String orderBy) Sets the property by which the results should be ordered

Methods inherited from class com.atlassian.crowd.search.query.entity.EntityQuery

equals, getEntityDescriptor, getMaxResults, getSearchRestriction, getStartIndex, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuditQuery

public AuditQuery(SearchRestriction searchRestriction,
                  int startIndex,
                  int maxResults)

AuditQuery

public AuditQuery(EntityQuery query)

AuditQuery

public AuditQuery(EntityQuery<AuditLogChangeset> query,
                  int startIndex,
                  int maxResults)

Method Detail

getReturnType

public Class<AuditLogChangeset> getReturnType()

Description copied from interface: Query

The type of elements to return.

Specified by:

getReturnType in interface Query<AuditLogChangeset>

Overrides:

getReturnType in class EntityQuery<AuditLogChangeset>

Returns:

the expected type of elements to be returned by the search.

getOrderBy

public String getOrderBy()

Returns:

the name of the property by which the results will be ordered

setOrderBy

public void setOrderBy(String orderBy)

Sets the property by which the results should be ordered

Parameters:

orderBy - the name of the property that should be used for ordering. Should match the properties from AuditLogTermKeys

isDescending

public boolean isDescending()

Returns:

true if the results should be in descending order, false if the results should be in ascending order

setDescending

public void setDescending(boolean descending)

Sets the ordering type in the query - descending or ascending

Parameters:

descending - determines if the order should be descending or not