com.atlassian.confluence.core
Class ListQuery

java.lang.Object
  com.atlassian.confluence.core.ListQuery

All Implemented Interfaces:

java.lang.Cloneable

public class ListQuery
extends java.lang.Object
implements java.lang.Cloneable

A Query for the SmartListManager

Field Summary

static java.util.List	ALL_TYPES
static java.lang.String	ALL_VERSIONS
static java.lang.String	LATEST_VERSIONS
static java.lang.String	SORT_BY_TIME_CREATED
static java.lang.String	SORT_BY_TIME_MODIFIED
static int	UNLIMITED_TIMESPAN

Constructor Summary

ListQuery()

ListQuery(ListQuery query)

Method Summary

ListQuery	addLabel(java.lang.String name) Adds a single label to the list of labels
ListQuery	addSpace(Space space) Adds a single Space to the list of Spaces to include
ListQuery	addStatus(java.lang.String str) Adds a single status type to the query
ListQuery	addType(java.lang.String type) Adds a content type to the query
java.lang.String	getDescription() Return a string which can be used as a description of the RSS feed defined by this query
java.util.List	getLabelList() Returns the list of labels that the query will restrict by
org.apache.lucene.search.BooleanClause.Occur	getLabelOccur()
int	getMaxResults() Retrieves the maximum number of results that will be returned by the Query
java.lang.String	getName() Retrieves the name given to the query
java.lang.String	getSortBy()
java.util.List	getSpaceList() Retrieves a List of Space objects that this query is being performed over
java.util.List	getSpaceScopes() List of Strings representing space scopes.
java.util.List	getStatusList() Retrieves a list of version status types to be included with the query.
float	getTimeSpan() Retrieves the time span (in days) that the query should cover
java.util.List	getTypeList() Retrieves a List of content types that this query is being performed over
com.atlassian.user.User	getUser() The user the query is being performed for
void	setLabelList(java.util.List labelList) Set the list of labels that the query will be restricted to
void	setLabelOccur(org.apache.lucene.search.BooleanClause.Occur labelOccur)
void	setMaxResults(int maxResults) Sets the maximum number of results that will be returned by the query
void	setName(java.lang.String name) Sets the name of the query
void	setSortBy(java.lang.String sortBy)
void	setSpaceList(java.util.List spaceList)
void	setSpaceScopes(java.util.List spaceScopes)
void	setStatusList(java.util.List statusList) Sets the status types to be included with the query Can be any of: "created" "modified" ALL_VERSIONS LATEST_VERSIONS Created vs Modified is checked by the DefaultFeedBuilder.
void	setTimeSpan(float timeSpan) Sets the amount of time to include before the current date If a time span of "1" is specified, the query will include content from 1 day ago until the current time A time span of "0" means there is no limit
void	setTypeList(java.util.List typeList) Sets the type of content to be included
void	setUser(com.atlassian.user.User user) Set the user this query will be performed for
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNLIMITED_TIMESPAN

public static final int UNLIMITED_TIMESPAN

See Also:

Constant Field Values

SORT_BY_TIME_CREATED

public static final java.lang.String SORT_BY_TIME_CREATED

See Also:

Constant Field Values

SORT_BY_TIME_MODIFIED

public static final java.lang.String SORT_BY_TIME_MODIFIED

See Also:

Constant Field Values

ALL_VERSIONS

public static final java.lang.String ALL_VERSIONS

See Also:

Constant Field Values

ALL_TYPES

public static final java.util.List ALL_TYPES

LATEST_VERSIONS

public static final java.lang.String LATEST_VERSIONS

See Also:

Constant Field Values

Constructor Detail

ListQuery

public ListQuery()

ListQuery

public ListQuery(ListQuery query)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getUser

public com.atlassian.user.User getUser()

The user the query is being performed for

Returns:

User object

getSpaceList

public java.util.List getSpaceList()

Retrieves a List of Space objects that this query is being performed over

Returns:

List of Space objects

getTypeList

public java.util.List getTypeList()

Retrieves a List of content types that this query is being performed over

Returns:

List of ContentEntityObject content types

setUser

public void setUser(com.atlassian.user.User user)

Set the user this query will be performed for

Parameters:

user - User object

setSpaceList

public void setSpaceList(java.util.List spaceList)

addType

public ListQuery addType(java.lang.String type)

Adds a content type to the query

Parameters:

type - the content type to include

Returns:

this ListQuery object

getName

public java.lang.String getName()

Retrieves the name given to the query

Returns:

the name

setName

public void setName(java.lang.String name)

Sets the name of the query

Parameters:

name - the name

getMaxResults

public int getMaxResults()

Retrieves the maximum number of results that will be returned by the Query

Returns:

int representing the maximum number of results

setMaxResults

public void setMaxResults(int maxResults)

Sets the maximum number of results that will be returned by the query

Parameters:

maxResults - the maximum number of results

getTimeSpan

public float getTimeSpan()

Retrieves the time span (in days) that the query should cover

Returns:

the time span (in days) before the current time to be included

setTimeSpan

public void setTimeSpan(float timeSpan)

Sets the amount of time to include before the current date

If a time span of "1" is specified, the query will include content from 1 day ago until the current time A time span of "0" means there is no limit

Parameters:

timeSpan - the number of days to include before the current date

setTypeList

public void setTypeList(java.util.List typeList)

Sets the type of content to be included

Parameters:

typeList - List of content types (Strings)

getStatusList

public java.util.List getStatusList()

Retrieves a list of version status types to be included with the query.

Returns:

List of status types

See Also:

setStatusList(java.util.List)

setStatusList

public void setStatusList(java.util.List statusList)

Sets the status types to be included with the query Can be any of:

• "created"
• "modified"
• ALL_VERSIONS
• LATEST_VERSIONS

Created vs Modified is checked by the DefaultFeedBuilder. All vs latest are checked by ContentEntityObjectHibernateDao.getRecentlyModifiedEntitiesByType(ListQuery, int). It's highly possible this field could be completely removed and nothing would actually break. TODO Split off the type of content to include (All vs LATEST) into a separate field

Parameters:

statusList - the List of status types to include

addStatus

public ListQuery addStatus(java.lang.String str)

Adds a single status type to the query

Parameters:

str - the status type to add

Returns:

this list query

getDescription

public java.lang.String getDescription()

Return a string which can be used as a description of the RSS feed defined by this query

getLabelList

public java.util.List getLabelList()

Returns the list of labels that the query will restrict by

Returns:

List of Label objects

setLabelList

public void setLabelList(java.util.List labelList)

Set the list of labels that the query will be restricted to

Parameters:

labelList - List of Label objects

addLabel

public ListQuery addLabel(java.lang.String name)

Adds a single label to the list of labels

Parameters:

name - the label name to add

Returns:

this list query

addSpace

public ListQuery addSpace(Space space)

Adds a single Space to the list of Spaces to include

Parameters:

space - the Space to add

Returns:

this list query

getSpaceScopes

public java.util.List getSpaceScopes()

List of Strings representing space scopes.

Returns:

a list of Strings that are possibly space scopes or maybe space keys!?!? It's a little hard to tell.

See Also:

com.atlassian.confluence.search.scope.SpaceScope#AVAILABLE_SCOPES}

setSpaceScopes

public void setSpaceScopes(java.util.List spaceScopes)

getSortBy

public java.lang.String getSortBy()

setSortBy

public void setSortBy(java.lang.String sortBy)

getLabelOccur

public org.apache.lucene.search.BooleanClause.Occur getLabelOccur()

setLabelOccur

public void setLabelOccur(org.apache.lucene.search.BooleanClause.Occur labelOccur)