|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.ResultFilter
public class ResultFilter
Filters and sorts lists of threads and messages. This allows for a very rich set of possible queries that can be run on forum data. Some examples are: "Show all messages posted in the forum during the last year by a certain user" or "Show all threads in the forum, sorted by their modification date".
The class also supports pagination of results with the setStartIndex(int) and setNumResults(int) methods. If the start index is not set, it will begin at index 0 (the start of results). If the number of results is not set, it will be unbounded and return as many results as available.
By default, result filters will obey the moderation rules as they are set for each forum. You can override this behavior by setting a moderation range.
Field Summary | |
---|---|
static int |
ASCENDING
Ascending sort (ie 3, 4, 5...). |
static int |
DESCENDING
Descending sort (ie 3, 2, 1...). |
static int |
NULL_INT
An integer value that represents NULL. |
Constructor Summary | |
---|---|
ResultFilter()
|
Method Summary | |
---|---|
static ResultFilter |
createDefaultForumFilter()
Creates a default forum ResultFilter: no filtering with results sorted on the category index value. |
static ResultFilter |
createDefaultMessageFilter()
Creates a default message ResultFilter: no filtering with results sorted on the message creation date in ascending order. |
static ResultFilter |
createDefaultThreadFilter()
Creates a default thread ResultFilter: no filtering with results sorted on the thread modification date. |
static ResultFilter |
createDefaultUserMessagesFilter()
Creates a default user messages ResultFilter: no filtering with results sorted on the message creation date descending (newest messages appear first). |
boolean |
equals(java.lang.Object o)
|
java.util.Date |
getCreationDateRangeMax()
Returns a date that represents the upper boundry for messages or threads to be selected by the result filter. |
java.util.Date |
getCreationDateRangeMin()
Returns the creation date that represents the lower boundary for messages or threads to be filtered on. |
int |
getModerationRangeMax()
Returns the moderation value that represents the upper bound for messages or threads to be selected by the result filter. |
int |
getModerationRangeMin()
Returns the moderation value that represents the lower boundry for messages or threads to be selected by the result filter. |
java.util.Date |
getModificationDateRangeMax()
Returns a date that represents the upper boundry for messages or threads to be selected by the result filter. |
java.util.Date |
getModificationDateRangeMin()
Returns a date that represents the lower boundary for messages or threads to be selected by the result filter. |
int |
getNumResults()
Returns the max number of results that should be returned. |
int |
getSortField()
Returns the currently selected sort field. |
int |
getSortOrder()
Returns the sort order, which will be ResultFilter.ASCENDING for ascending sorting, or ResultFilter.DESCENDING for descending sorting. |
int |
getStartIndex()
Returns the index of the first result to return. |
long |
getUserID()
Returns the userID that results will be filtered on. |
int |
hashCode()
|
void |
setCreationDateRangeMax(java.util.Date creationDateRangeMax)
Sets a date that represents the upper boundry for messages or threads to be selected by the result filter. |
void |
setCreationDateRangeMin(java.util.Date creationDateRangeMin)
Sets the date that represents the lower boundary for messages or threads to be selected by the result filter. |
void |
setModerationRangeMax(int moderationRangeMax)
Sets the upper bound for the moderation value that will pass the result filter. |
void |
setModerationRangeMin(int moderationRangeMin)
Sets the moderation value that represents the lower bound for messages or threads to be selected by the result filter. |
void |
setModificationDateRangeMax(java.util.Date modificationDateRangeMax)
Sets a date that represents the upper boundry for messages or threads to be selected by the result filter. |
void |
setModificationDateRangeMin(java.util.Date modificationDateRangeMin)
Sets a date that represents the lower boundary for messages or threads to be selected by the result filter. |
void |
setNumResults(int numResults)
Sets the limit on the number of results to be returned. |
void |
setSortField(int sortField)
Sets the sort field to use. |
void |
setSortOrder(int sortOrder)
Sets the sort type. |
void |
setStartIndex(int startIndex)
Sets the index of the first result to return. |
void |
setUserID(long userID)
Sets the userID that results will be filtered on. |
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 DESCENDING
public static final int ASCENDING
public static final int NULL_INT
Constructor Detail |
---|
public ResultFilter()
Method Detail |
---|
public static ResultFilter createDefaultForumFilter()
public static ResultFilter createDefaultThreadFilter()
public static ResultFilter createDefaultMessageFilter()
public static ResultFilter createDefaultUserMessagesFilter()
public long getUserID()
public void setUserID(long userID)
userID
- the user ID to filter on.public java.util.Date getCreationDateRangeMin()
public void setCreationDateRangeMin(java.util.Date creationDateRangeMin)
Setting a date range for a ResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).
creationDateRangeMin
- Date representing the filter lowest value of
the creation date to be selected.public java.util.Date getCreationDateRangeMax()
public void setCreationDateRangeMax(java.util.Date creationDateRangeMax)
creationDateRangeMax
- Date representing the filter lowest value of
the creation date range.public java.util.Date getModificationDateRangeMin()
public void setModificationDateRangeMin(java.util.Date modificationDateRangeMin)
modificationDateRangeMin
- Date representing the filter lowest value of
the modified date to be selected.public java.util.Date getModificationDateRangeMax()
public void setModificationDateRangeMax(java.util.Date modificationDateRangeMax)
modificationDateRangeMax
- Date representing the filter lowest value of
the modified date range.public int getSortField()
JiveConstants.MODIFICATION_DATE
.Valid sort fields for object types are as follows:
JiveConstants.MODIFICATION_DATE
, JiveConstants.CREATION_DATE
,
JiveConstants.FORUM_CATEGORY_INDEX
, JiveConstants.FORUM_NAME
JiveConstants.MODIFICATION_DATE
, JiveConstants.CREATION_DATE
,
JiveConstants.THREAD_NAME
JiveConstants.MODIFICATION_DATE
, JiveConstants.CREATION_DATE
,
JiveConstants.MESSAGE_SUBJECT
public void setSortField(int sortField)
Valid sort fields for object types are as follows:
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 int getNumResults()
setStartIndex(int)
public void setNumResults(int numResults)
numResults
- the number of results to return.public int getStartIndex()
public void setStartIndex(int startIndex)
startIndex
- the index of the first result to return.public int getModerationRangeMin()
public void setModerationRangeMin(int moderationRangeMin)
moderationRangeMin
- int representing the lowest value of
the moderation value range to be selected by the result filter.public int getModerationRangeMax()
public void setModerationRangeMax(int moderationRangeMax)
moderationRangeMax
- the max value of the moderation value range.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 |