com.atlassian.confluence.core
Class ListQuery

java.lang.Object
  extended by com.atlassian.confluence.core.ListQuery
All Implemented Interfaces:
Cloneable

Deprecated. since 4.2 use the SearchManager

@Deprecated
public class ListQuery
extends Object
implements Cloneable

A Query for the SmartListManager


Field Summary
static List<String> ALL_TYPES
          Deprecated.  
static String ALL_VERSIONS
          Deprecated.  
static String LATEST_VERSIONS
          Deprecated.  
static String SORT_BY_TIME_CREATED
          Deprecated.  
static String SORT_BY_TIME_MODIFIED
          Deprecated.  
static int UNLIMITED_RESULTS
          Deprecated.  
static int UNLIMITED_TIMESPAN
          Deprecated.  
 
Constructor Summary
ListQuery()
          Deprecated.  
ListQuery(ListQuery query)
          Deprecated.  
 
Method Summary
 ListQuery addLabel(String name)
          Deprecated. Adds a single label to the list of labels
 ListQuery addSpace(Space space)
          Deprecated. Adds a single Space to the list of Spaces to include
 ListQuery addStatus(String str)
          Deprecated. Adds a single status type to the query
 ListQuery addType(String type)
          Deprecated. Adds a content type to the query
 List<String> getBlogpostSubTypes()
          Deprecated.  
 String getDescription()
          Deprecated. Return a string which can be used as a description of the RSS feed defined by this query
 List<String> getExcludedSpaceKeys()
          Deprecated.  
 List getLabelList()
          Deprecated. Returns the list of labels that the query will restrict by
 org.apache.lucene.search.BooleanClause.Occur getLabelOccur()
          Deprecated.  
 int getMaxResults()
          Deprecated. Retrieves the maximum number of results that will be returned by the Query
 String getName()
          Deprecated. Retrieves the name given to the query
 List<String> getPageSubTypes()
          Deprecated.  
 String getSortBy()
          Deprecated.  
 List getSpaceList()
          Deprecated. Retrieves a List of Space objects that this query is being performed over
 List getSpaceScopes()
          Deprecated. List of Strings representing space scopes.
 List getStatusList()
          Deprecated. Retrieves a list of version status types to be included with the query.
 float getTimeSpan()
          Deprecated. Retrieves the time span (in days) that the query should cover
 List getTypeList()
          Deprecated. Retrieves a List of content types that this query is being performed over
 com.atlassian.user.User getUser()
          Deprecated. The user the query is being performed for
 void setBlogpostSubTypes(List<String> blogSubTypes)
          Deprecated.  
 void setExcludedSpaceKeys(List<String> excludedSpaceKeys)
          Deprecated.  
 void setLabelList(List labelList)
          Deprecated. Set the list of labels that the query will be restricted to
 void setLabelOccur(org.apache.lucene.search.BooleanClause.Occur labelOccur)
          Deprecated.  
 void setMaxResults(int maxResults)
          Deprecated. Sets the maximum number of results that will be returned by the query
 void setName(String name)
          Deprecated. Sets the name of the query
 void setPageSubTypes(List<String> pageSubTypes)
          Deprecated.  
 void setSortBy(String sortBy)
          Deprecated.  
 void setSpaceList(List spaceList)
          Deprecated.  
 void setSpaceScopes(List spaceScopes)
          Deprecated.  
 void setStatusList(List statusList)
          Deprecated. 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)
          Deprecated. 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(List typeList)
          Deprecated. Sets the type of content to be included
 void setUser(com.atlassian.user.User user)
          Deprecated. Set the user this query will be performed for
 String toString()
          Deprecated.  
 
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
Deprecated. 
See Also:
Constant Field Values

UNLIMITED_RESULTS

public static final int UNLIMITED_RESULTS
Deprecated. 
See Also:
Constant Field Values

SORT_BY_TIME_CREATED

public static final String SORT_BY_TIME_CREATED
Deprecated. 
See Also:
Constant Field Values

SORT_BY_TIME_MODIFIED

public static final String SORT_BY_TIME_MODIFIED
Deprecated. 
See Also:
Constant Field Values

ALL_VERSIONS

public static final String ALL_VERSIONS
Deprecated. 
See Also:
Constant Field Values

ALL_TYPES

public static final List<String> ALL_TYPES
Deprecated. 

LATEST_VERSIONS

public static final String LATEST_VERSIONS
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

ListQuery

public ListQuery()
Deprecated. 

ListQuery

public ListQuery(ListQuery query)
Deprecated. 
Method Detail

toString

public String toString()
Deprecated. 
Overrides:
toString in class Object

getUser

public com.atlassian.user.User getUser()
Deprecated. 
The user the query is being performed for

Returns:
User object

getSpaceList

public List getSpaceList()
Deprecated. 
Retrieves a List of Space objects that this query is being performed over

Returns:
List of Space objects

getTypeList

public List getTypeList()
Deprecated. 
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)
Deprecated. 
Set the user this query will be performed for

Parameters:
user - User object

setSpaceList

public void setSpaceList(List spaceList)
Deprecated. 

addType

public ListQuery addType(String type)
Deprecated. 
Adds a content type to the query

Parameters:
type - the content type to include
Returns:
this ListQuery object

getName

public String getName()
Deprecated. 
Retrieves the name given to the query

Returns:
the name

setName

public void setName(String name)
Deprecated. 
Sets the name of the query

Parameters:
name - the name

getMaxResults

public int getMaxResults()
Deprecated. 
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)
Deprecated. 
Sets the maximum number of results that will be returned by the query

Parameters:
maxResults - the maximum number of results

getTimeSpan

public float getTimeSpan()
Deprecated. 
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)
Deprecated. 
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(List typeList)
Deprecated. 
Sets the type of content to be included

Parameters:
typeList - List of content types (Strings)

getStatusList

public List getStatusList()
Deprecated. 
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(List statusList)
Deprecated. 
Sets the status types to be included with the query Can be any of: Created vs Modified is checked by the DefaultFeedBuilder. 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(String str)
Deprecated. 
Adds a single status type to the query

Parameters:
str - the status type to add
Returns:
this list query

getDescription

public String getDescription()
Deprecated. 
Return a string which can be used as a description of the RSS feed defined by this query


getLabelList

public List getLabelList()
Deprecated. 
Returns the list of labels that the query will restrict by

Returns:
List of Label objects

setLabelList

public void setLabelList(List labelList)
Deprecated. 
Set the list of labels that the query will be restricted to

Parameters:
labelList - List of Label objects

addLabel

public ListQuery addLabel(String name)
Deprecated. 
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)
Deprecated. 
Adds a single Space to the list of Spaces to include

Parameters:
space - the Space to add
Returns:
this list query

getSpaceScopes

public List getSpaceScopes()
Deprecated. 
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:
SpaceScope.AVAILABLE_SCOPES

setSpaceScopes

public void setSpaceScopes(List spaceScopes)
Deprecated. 

getSortBy

public String getSortBy()
Deprecated. 

setSortBy

public void setSortBy(String sortBy)
Deprecated. 

getLabelOccur

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

setLabelOccur

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

setBlogpostSubTypes

public void setBlogpostSubTypes(List<String> blogSubTypes)
Deprecated. 

setPageSubTypes

public void setPageSubTypes(List<String> pageSubTypes)
Deprecated. 

getBlogpostSubTypes

public List<String> getBlogpostSubTypes()
Deprecated. 

getPageSubTypes

public List<String> getPageSubTypes()
Deprecated. 

setExcludedSpaceKeys

public void setExcludedSpaceKeys(List<String> excludedSpaceKeys)
Deprecated. 

getExcludedSpaceKeys

public List<String> getExcludedSpaceKeys()
Deprecated. 


Copyright © 2003–2015 Atlassian. All rights reserved.