|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.Query
public class Query
Provides the ability to create complex search queries.
Field Summary | |
---|---|
static int |
ASCENDING
Ascending sort (ie 3, 4, 5...). |
static int |
DATE
Sort by date |
static int |
DESCENDING
Descending sort (ie 3, 2, 1...). |
static int |
RATING
Sort by rating |
static int |
RELEVANCE
Sort by relevance |
static int |
SUBJECT
Sort by message subject |
Constructor Summary | |
---|---|
Query()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
java.util.Date |
getAfterDate()
Returns the earliest date for search results. |
java.util.Date |
getBeforeDate()
Returns the latest date for search results. |
long |
getFilterOnUserID()
Returns the userID, used for filtering messages by a specific author. |
java.lang.String |
getQueryString()
Returns the query string for the Query object. |
int |
getSortField()
Returns the currently selected sort field. |
int |
getSortOrder()
Returns the sort order, which will be Query.ASCENDING for ascending sorting, or Query.DESCENDING for descending sorting. |
int |
hashCode()
|
void |
setAfterDate(java.util.Date afterDate)
Sets the earliest date for search results. |
void |
setBeforeDate(java.util.Date beforeDate)
Sets the latest date for search results. |
void |
setFilterOnUserID(long userID)
Restricts the query results to messages posted by a specified user. |
void |
setQueryString(java.lang.String queryString)
Sets the query string for the Query object. |
void |
setSortField(int sortField)
Sets the sort field to use. |
void |
setSortOrder(int sortOrder)
Sets the sort type. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int RELEVANCE
public static final int RATING
public static final int DATE
public static final int SUBJECT
public static final int DESCENDING
public static final int ASCENDING
Constructor Detail |
---|
public Query()
Method Detail |
---|
public java.lang.String getQueryString()
public void setQueryString(java.lang.String queryString)
queryString
- a new query string.public java.util.Date getBeforeDate()
If the "before date" has not been set, this method will return null.
public void setBeforeDate(java.util.Date beforeDate)
beforeDate
- an upper date boundary for search results.public java.util.Date getAfterDate()
If the "after date" has not been set, this method will return null.
public void setAfterDate(java.util.Date afterDate)
afterDate
- a lower date boundary for search results.public int getSortField()
public void setSortField(int sortField)
sortField
- the field that will be used for sorting.public int getSortOrder()
public void setSortOrder(int sortOrder)
sortOrder
- the order that results will be sorted in.public long getFilterOnUserID()
public void setFilterOnUserID(long userID)
ContentService.getMessagesByUserID(userID)
method for a user's
messages among all forums.
userID,
- used for filtering messages by a specific author.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |