|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.core.ListQuery
A Query for the SmartListManager
Field Summary | |
static List |
ALL_TYPES
|
static String |
ALL_VERSIONS
|
static String |
LATEST_VERSIONS
|
static String |
SORT_BY_TIME_CREATED
|
static String |
SORT_BY_TIME_MODIFIED
|
static int |
UNLIMITED_TIMESPAN
|
Constructor Summary | |
ListQuery()
|
|
ListQuery(ListQuery query)
|
Method Summary | |
ListQuery |
addLabel(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(String str)
Adds a single status type to the query |
ListQuery |
addType(String type)
Adds a content type to the query |
String |
getDescription()
Return a string which can be used as a description of the RSS feed defined by this query |
List |
getLabelList()
Returns the list of labels that the query will restrict by |
int |
getMaxResults()
Retrieves the maximum number of results that will be returned by the Query |
String |
getName()
Retrieves the name given to the query |
String |
getSortBy()
|
List |
getSpaceList()
Retrieves a List of Space objects that this query is being performed over |
List |
getSpaceScopes()
|
List |
getStatusList()
Retrieves a list of status types to be included with the query |
float |
getTimeSpan()
Retrieves the time span (in days) that the query should cover |
List |
getTypeList()
Retrieves a List of content types that this query is being performed over |
User |
getUser()
The user the query is being performed for |
void |
setLabelList(List labelList)
Set the list of labels that the query will be restricted to |
void |
setMaxResults(int maxResults)
Sets the maximum number of results that will be returned by the query |
void |
setName(String name)
Sets the name of the query |
void |
setSortBy(String sortBy)
|
void |
setSpaceList(List spaceList)
|
void |
setSpaceScopes(List spaceScopes)
|
void |
setStatusList(List statusList)
Sets the status types to be included with the query Can be any of: "created" "modified" ALL_VERSIONS LATEST_VERSION TODO Split off the type of content to include (All vs LATEST) into a separate field |
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(List typeList)
Sets the type of content to be included |
void |
setUser(User user)
Set the user this query will be performed for |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int UNLIMITED_TIMESPAN
public static final String SORT_BY_TIME_CREATED
public static final String SORT_BY_TIME_MODIFIED
public static final String ALL_VERSIONS
public static final List ALL_TYPES
public static final String LATEST_VERSIONS
Constructor Detail |
public ListQuery()
public ListQuery(ListQuery query)
Method Detail |
public User getUser()
public List getSpaceList()
public List getTypeList()
public void setUser(User user)
user
- User objectpublic void setSpaceList(List spaceList)
public ListQuery addType(String type)
type
- the content type to include
public String getName()
public void setName(String name)
name
- the namepublic int getMaxResults()
public void setMaxResults(int maxResults)
maxResults
- the maximum number of resultspublic float getTimeSpan()
public void setTimeSpan(float timeSpan)
timeSpan
- the number of days to include before the current datepublic void setTypeList(List typeList)
typeList
- List of content types (Strings)public List getStatusList()
public void setStatusList(List statusList)
statusList
- the List of status types to includepublic ListQuery addStatus(String str)
str
- the status type to add
public String getDescription()
public List getLabelList()
public void setLabelList(List labelList)
labelList
- List of Label objectspublic ListQuery addLabel(String name)
name
- the label name to add
public ListQuery addSpace(Space space)
space
- the Space to add
public List getSpaceScopes()
public void setSpaceScopes(List spaceScopes)
public String getSortBy()
public void setSortBy(String sortBy)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |