|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.AnnouncementFilter
public class AnnouncementFilter
Filters and sorts lists of announcements. Results may be filtered and/or sorted by userID and subject.
The class also supports pagination of announcements with the setStartIndex(int) and setNumResults(int) methods. If the start index is not set, it will begin at index 0. If the number of results is not set, it will be unbounded and return as many results as available.
Field Summary | |
---|---|
static int |
ANNOUNCEMENT_SUBJECT
|
static int |
ASCENDING
|
static int |
DESCENDING
|
static int |
END_DATE
|
static int |
NULL_INT
An integer value that represents NULL. |
static int |
START_DATE
|
static int |
USER_ID
|
static int |
USER_NAME
|
Constructor Summary | |
---|---|
AnnouncementFilter()
|
Method Summary | |
---|---|
java.lang.Object |
clone()
Clones a AnnouncementFilter |
boolean |
equals(java.lang.Object o)
|
java.util.Date |
getEndDateRangeMax()
Returns the maximum end date on which results will be filtered. |
java.util.Date |
getEndDateRangeMin()
Returns the minimum end date on which results will be filtered. |
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. |
java.util.Date |
getStartDateRangeMax()
Returns the maximum start date on which results will be filtered. |
java.util.Date |
getStartDateRangeMin()
Returns the minimum start date on which results will be filtered. |
int |
getStartIndex()
Returns the index of the first result to return. |
java.lang.String |
getSubject()
Returns the subject string that results will be filtered on. |
long |
getUserID()
Returns the userID that results will be filtered on. |
java.lang.String |
getUsername()
Returns the user name string that results will be filtered on. |
int |
hashCode()
|
boolean |
isCaseSensitive()
Returns whether or not string matching is case sensitive. |
void |
setCaseSensitive(boolean caseSensitive)
Sets case sensitivity for string matching |
void |
setEndDateRangeMax(java.util.Date endDateRangeMax)
Sets the maximum end date on which results will be filtered. |
void |
setEndDateRangeMin(java.util.Date endDateRangeMin)
Sets the minimum end date on which results will be filtered. |
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 order. |
void |
setStartDateRangeMax(java.util.Date startDateRangeMax)
Sets the maximum start date on which results will be filtered. |
void |
setStartDateRangeMin(java.util.Date startDateRangeMin)
Sets the minimum start date on which results will be filtered. |
void |
setStartIndex(int startIndex)
Sets the index of the first result to return. |
void |
setSubject(java.lang.String subject)
Sets the subject string that results will be filtered on. |
void |
setUserID(long userID)
Sets the userID that results will be filtered on. |
void |
setUsername(java.lang.String username)
Sets the user name string that results will be filtered on. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DESCENDING
public static final int ASCENDING
public static final int USER_ID
public static final int USER_NAME
public static final int ANNOUNCEMENT_SUBJECT
public static final int START_DATE
public static final int END_DATE
public static final int NULL_INT
Constructor Detail |
---|
public AnnouncementFilter()
Method Detail |
---|
public long getUserID()
public void setUserID(long userID)
userID
- the user ID to filter on.public java.lang.String getUsername()
public void setUsername(java.lang.String username)
username
- the subject string to filter on.public java.lang.String getSubject()
public void setSubject(java.lang.String subject)
subject
- the subject string to filter on.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 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 java.util.Date getStartDateRangeMin()
public void setStartDateRangeMin(java.util.Date startDateRangeMin)
startDateRangeMin
- the minimum start date.public java.util.Date getStartDateRangeMax()
public void setStartDateRangeMax(java.util.Date startDateRangeMax)
startDateRangeMax
- the maximum start date.public java.util.Date getEndDateRangeMin()
public void setEndDateRangeMin(java.util.Date endDateRangeMin)
endDateRangeMin
- the minimum end date.public java.util.Date getEndDateRangeMax()
public void setEndDateRangeMax(java.util.Date endDateRangeMax)
endDateRangeMax
- the maximum end date.public boolean isCaseSensitive()
public void setCaseSensitive(boolean caseSensitive)
caseSensitive
- case sensitivity.public java.lang.Object clone()
clone
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
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 |