|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.compoze.ebusiness.AbstractFilter | +--com.compoze.discussion.ForumFilter
This class represents a forum filter. A forum filter
is used to restrict the forums that are returned as
they are iterated over in a Forums
collection.
By setting properties in this filter, the forums that
are returned include only those forums with properties
that are the same. The string are case-insensitive.
By default, the forum filter only includes forums
which do not have the archive flag set to true
(i.e. forums that are not archived).
To modify this behavior, use the methods unsetArchive()
and setArchive(boolean)
after you create a forum filter.
See the Forums
class for futher details and
examples on how to filter forums.
Forums.setFilter(ForumFilter)
, Serialized FormFields inherited from class com.compoze.ebusiness.AbstractFilter |
m_rules, m_where |
Constructor Summary | |
ForumFilter()
Constructor. |
Method Summary | |
void |
appendFilter(ForumFilter filter,
boolean bOr)
Appends the filter to this filter. |
void |
clearFilters()
Clears all filter that are appended to this filter. |
com.compoze.ejb.persistence.database.IFilterRule |
getFilterRule()
|
java.util.List |
getFilters()
Gets a unmodifiable list of forum filters appended to this filter. |
void |
removeFilter(ForumFilter filter)
Removes the filter from this filter. |
void |
setArchive(boolean bArchive)
Sets filtering by archive flag. |
void |
setAuthor(java.lang.String sAuthor)
Sets filtering by author. |
void |
setAuthor(java.lang.String[] authors)
Sets filtering by author. |
void |
setAuthor(java.lang.String[] authors,
boolean bExactMatch)
Sets filtering by authors. |
void |
setAuthor(java.lang.String sAuthor,
boolean bExactMatch)
Sets filtering by author. |
void |
setCustomNum1(long lCustomNum1)
Sets filtering by the custom num1 field. |
void |
setCustomNum1(long[] customNum1s)
Sets filtering by the custom num1 field. |
void |
setCustomNum1(long lCustomNum1,
boolean bGreaterThan)
Sets filtering by the custom num1 field. |
void |
setCustomNum1(long lFromCount,
long lToCount)
Sets filtering by custom num1 between the specified range. |
void |
setCustomNum2(long lCustomNum2)
Sets filtering by the custom num2 field. |
void |
setCustomNum2(long[] customNum2s)
Sets filtering by the custom num2 field. |
void |
setCustomNum2(long lCustomNum2,
boolean bGreaterThan)
Sets filtering by the custom num2 field. |
void |
setCustomNum2(long lFromCount,
long lToCount)
Sets filtering by custom num2 between the specified range. |
void |
setCustomNum3(long lCustomNum3)
Sets filtering by the custom num3 field. |
void |
setCustomNum3(long[] customNum3s)
Sets filtering by the custom num3 field. |
void |
setCustomNum3(long lCustomNum3,
boolean bGreaterThan)
Sets filtering by the custom num3 field. |
void |
setCustomNum3(long lFromCount,
long lToCount)
Sets filtering by custom num3 between the specified range. |
void |
setCustomNum4(long lCustomNum4)
Sets filtering by the custom num4 field. |
void |
setCustomNum4(long[] customNum4s)
Sets filtering by the custom num4 field. |
void |
setCustomNum4(long lCustomNum4,
boolean bGreaterThan)
Sets filtering by the custom num4 field. |
void |
setCustomNum4(long lFromCount,
long lToCount)
Sets filtering by custom num4 between the specified range. |
void |
setCustomStr1(java.lang.String sCustomStr1)
Sets filtering by custom str1. |
void |
setCustomStr1(java.lang.String[] customString1s)
Sets filtering by custom str1. |
void |
setCustomStr1(java.lang.String[] customString1s,
boolean bExactMatch)
Sets filtering by custom str1. |
void |
setCustomStr1(java.lang.String sCustomStr1,
boolean bExactMatch)
Sets filtering by custom str1. |
void |
setCustomStr2(java.lang.String sCustomStr2)
Sets filtering by custom str2. |
void |
setCustomStr2(java.lang.String[] customString2s)
Sets filtering by custom str2. |
void |
setCustomStr2(java.lang.String[] customString2s,
boolean bExactMatch)
Sets filtering by custom str2. |
void |
setCustomStr2(java.lang.String sCustomStr2,
boolean bExactMatch)
Sets filtering by custom str2. |
void |
setCustomStr3(java.lang.String sCustomStr3)
Sets filtering by custom str3. |
void |
setCustomStr3(java.lang.String[] customString3s)
Sets filtering by custom str3. |
void |
setCustomStr3(java.lang.String[] customString3s,
boolean bExactMatch)
Sets filtering by custom str3. |
void |
setCustomStr3(java.lang.String sCustomStr3,
boolean bExactMatch)
Sets filtering by custom str3. |
void |
setCustomStr4(java.lang.String sCustomStr4)
Sets filtering by custom str4. |
void |
setCustomStr4(java.lang.String[] customString4s)
Sets filtering by custom str4. |
void |
setCustomStr4(java.lang.String[] customString4s,
boolean bExactMatch)
Sets filtering by custom str4. |
void |
setCustomStr4(java.lang.String sCustomStr4,
boolean bExactMatch)
Sets filtering by custom str4. |
void |
setDateCreated(java.util.Date startDate,
java.util.Date endDate)
Sets filtering by a date created range. |
void |
setDateLastModified(java.util.Date startDate,
java.util.Date endDate)
Sets filtering by a date last modified range. |
void |
setDescription(java.lang.String sDescription)
Sets filtering by description. |
void |
setDescription(java.lang.String[] descriptions)
Sets filtering by description. |
void |
setDescription(java.lang.String[] descriptions,
boolean bExactMatch)
Sets filtering by description. |
void |
setDescription(java.lang.String sDescription,
boolean bExactMatch)
Sets filtering by description. |
void |
setExpirationDate(java.util.Date startDate,
java.util.Date endDate)
Sets filtering by an expiration date range. |
void |
setKeywords(java.lang.String sKeywords)
Sets filtering by keywords. |
void |
setKeywords(java.lang.String[] keywords)
Sets filtering by keywords. |
void |
setKeywords(java.lang.String[] keywords,
boolean bExactMatch)
Sets filtering by keywords. |
void |
setKeywords(java.lang.String sKeywords,
boolean bExactMatch)
Sets filtering by keywords. |
void |
setMaximumTopicCount(int iCount,
boolean bGreaterThan)
Sets filtering by maximum topic count. |
void |
setMaximumTopicCount(int iFromCount,
int iToCount)
Sets filtering by maximum topic count between the specified range. |
void |
setMessageCount(int iCount,
boolean bGreaterThan)
Sets filtering by message count. |
void |
setMessageCount(int iFromCount,
int iToCount)
Sets filtering by message count between the specified range. |
void |
setName(java.lang.String sName)
Sets filtering by name. |
void |
setName(java.lang.String[] names)
Sets filtering by name. |
void |
setName(java.lang.String[] names,
boolean bExactMatch)
Sets filtering by name. |
void |
setName(java.lang.String sName,
boolean bExactMatch)
Sets filtering by name. |
void |
setTopicCount(int iCount,
boolean bGreaterThan)
Sets filtering by topic count. |
void |
setTopicCount(int iFromCount,
int iToCount)
Sets filtering by topic count between the specified range. |
void |
setType(ForumType type)
Sets filtering by forum type. |
void |
setType(ForumType[] types)
Sets filtering by forum type. |
void |
unsetArchive()
Unsets filterting by archive flag. |
void |
unsetAuthor()
Unsets filterting by author. |
void |
unsetCustomNum1()
Unsets filtering by custom num1. |
void |
unsetCustomNum2()
Unsets filtering by custom num2. |
void |
unsetCustomNum3()
Unsets filtering by custom num3. |
void |
unsetCustomNum4()
Unsets filtering by custom num4. |
void |
unsetCustomStr1()
Unsets filterting by custom str1. |
void |
unsetCustomStr2()
Unsets filterting by custom str2. |
void |
unsetCustomStr3()
Unsets filterting by custom str3. |
void |
unsetCustomStr4()
Unsets filterting by custom str4. |
void |
unsetDateCreated()
Unsets filtering by date created. |
void |
unsetDateLastModified()
Unsets filtering by date last modified. |
void |
unsetDescription()
Unsets filterting by description. |
void |
unsetExpirationDate()
Unsets filtering by expiration date. |
void |
unsetKeywords()
Unsets filterting by keywords. |
void |
unsetMaximumTopicCount()
Unsets filtering by message count. |
void |
unsetMessageCount()
Unsets filtering by message count. |
void |
unsetName()
Unsets filterting by name. |
void |
unsetTopicCount()
Unsets filtering by topic count. |
void |
unsetType()
Unsets filterting by type flag. |
Methods inherited from class com.compoze.ebusiness.AbstractFilter |
clearWhereClause, getBaseRule, getOr, getWhereClause, isEmpty, setBeginsRule, setGreaterThanRule, setLessThanRule, setNotRule, setOr, setRule, setRule, setRule, setRule, setRule, setRule, setRule, setRule, setRule, setRule, setWhereClause, toRule, toString, unsetBeginsRule, unsetNotRule |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ForumFilter()
Method Detail |
public void appendFilter(ForumFilter filter, boolean bOr)
filter
- the filter the appendbOr
- true
to append this filter with an 'or'; false
to use 'and'public void removeFilter(ForumFilter filter)
filter
- the filter to removepublic void clearFilters()
public java.util.List getFilters()
ForumFilter
objectspublic void setName(java.lang.String sName)
sName
- the namesetName(String, boolean)
public void setName(java.lang.String sName, boolean bExactMatch)
sName
- the namebExactMatch
- true
for an exact match of the string name; false
to match as substring namepublic void setName(java.lang.String[] names)
names
- the namessetName(String[], boolean)
public void setName(java.lang.String[] names, boolean bExactMatch)
names
- the namesexact
- true
for an exact match of the names; false
to match a substringpublic void unsetName()
public void setDescription(java.lang.String sDescription)
sDescription
- the descriptionsetDescription(String, boolean)
public void setDescription(java.lang.String sDescription, boolean bExactMatch)
sDescription
- the descriptionbExactMatch
- true
for an exact match of the string description; false
to match as substring descriptionpublic void setDescription(java.lang.String[] descriptions)
descriptions
- the descriptionssetDescription(String[], boolean)
public void setDescription(java.lang.String[] descriptions, boolean bExactMatch)
descriptions
- the descriptionsexact
- true
for an exact match of the descriptions; false
to match a substringpublic void unsetDescription()
public void setKeywords(java.lang.String sKeywords)
sKeywords
- the keywordssetKeywords(String, boolean)
public void setKeywords(java.lang.String sKeywords, boolean bExactMatch)
sKeywords
- the keywordsbExactMatch
- true
for an exact match of the string keywords; false
to match as substring keywordspublic void setKeywords(java.lang.String[] keywords)
keywords
- the keywordssetKeywords(String[], boolean)
public void setKeywords(java.lang.String[] keywords, boolean bExactMatch)
keywords
- the keywordsexact
- true
for an exact match of the keywords; false
to match a substringpublic void unsetKeywords()
public void setAuthor(java.lang.String sAuthor)
sAuthor
- the authorsetAuthor(String, boolean)
public void setAuthor(java.lang.String sAuthor, boolean bExactMatch)
sAuthor
- the authorbExactMatch
- true
for an exact match of the string author; false
to match as substring authorpublic void setAuthor(java.lang.String[] authors)
authors
- the authorssetAuthor(String[], boolean)
public void setAuthor(java.lang.String[] authors, boolean bExactMatch)
authors
- the authorsbExactMatch
- true
for an exact match of the authors; false
to match a substringpublic void unsetAuthor()
public void setTopicCount(int iCount, boolean bGreaterThan)
iCount
- the topic countbGreaterThan
- true
for topic count greater than specified count; false
for topic count less than specified countsetTopicCount(int,int)
public void setTopicCount(int iFromCount, int iToCount)
iFromCount
must be less
than the iToCount
.iFromCount
- the topic count low rangeiToCount
- the topic count high rangepublic void unsetTopicCount()
public void setMessageCount(int iCount, boolean bGreaterThan)
iCount
- the message countbGreaterThan
- true
for message count greater than specified count; false
for message count less than specified countsetMessageCount(int,int)
public void setMessageCount(int iFromCount, int iToCount)
iFromCount
must be less
than the iToCount
.iFromCount
- the message count low rangeiToCount
- the message count high rangepublic void unsetMessageCount()
public void setMaximumTopicCount(int iCount, boolean bGreaterThan)
iCount
- the maximum topic countbGreaterThan
- true
for maximum topic count greater than specified count; false
for maximum topic count less than specified countsetMaximumTopicCount(int,int)
public void setMaximumTopicCount(int iFromCount, int iToCount)
iFromCount
must be less
than the iToCount
.iFromCount
- the maximum topic count low rangeiToCount
- the maximum topic count high rangepublic void unsetMaximumTopicCount()
public void setExpirationDate(java.util.Date startDate, java.util.Date endDate)
startDate
- the expiration date start rangeendDate
- the expiration date end rangepublic void unsetExpirationDate()
public void setDateCreated(java.util.Date startDate, java.util.Date endDate)
startDate
- the date created start rangeendDate
- the date created end rangepublic void unsetDateCreated()
public void setDateLastModified(java.util.Date startDate, java.util.Date endDate)
startDate
- the date last modified start rangeendDate
- the date last modified end rangepublic void unsetDateLastModified()
public void setCustomNum1(long[] customNum1s)
lCustomNum1
- the custom num1public void setCustomNum1(long lCustomNum1)
lCustomNum1
- the custom num1public void setCustomNum1(long lCustomNum1, boolean bGreaterThan)
lCustomNum1
- the custom num1bGreaterThan
- true
for custom num1 greater than specified number; false
for custom num1 less than specified numberpublic void setCustomNum1(long lFromCount, long lToCount)
lFromCount
must be less
than the lToCount
.lFromCount
- the custom num1 low rangelToCount
- the custom num1 high rangepublic void unsetCustomNum1()
public void setCustomNum2(long[] customNum2s)
lCustomNum2
- the custom num2public void setCustomNum2(long lCustomNum2)
lCustomNum2
- the custom num2public void setCustomNum2(long lCustomNum2, boolean bGreaterThan)
lCustomNum2
- the custom num2bGreaterThan
- true
for custom num2 greater than specified number; false
for custom num2 less than specified numberpublic void setCustomNum2(long lFromCount, long lToCount)
lFromCount
must be less
than the lToCount
.lFromCount
- the custom num2 low rangelToCount
- the custom num2 high rangepublic void unsetCustomNum2()
public void setCustomNum3(long[] customNum3s)
lCustomNum3
- the custom num3public void setCustomNum3(long lCustomNum3)
lCustomNum3
- the custom num3public void setCustomNum3(long lCustomNum3, boolean bGreaterThan)
lCustomNum3
- the custom num3bGreaterThan
- true
for custom num3 greater than specified number; false
for custom num3 less than specified numberpublic void setCustomNum3(long lFromCount, long lToCount)
lFromCount
must be less
than the lToCount
.lFromCount
- the custom num1 low rangelToCount
- the custom num1 high rangepublic void unsetCustomNum3()
public void setCustomNum4(long[] customNum4s)
lCustomNum4
- the custom num4public void setCustomNum4(long lCustomNum4)
lCustomNum4
- the custom num4public void setCustomNum4(long lCustomNum4, boolean bGreaterThan)
lCustomNum4
- the custom num4bGreaterThan
- true
for custom num4 greater than specified number; false
for custom num4 less than specified numberpublic void setCustomNum4(long lFromCount, long lToCount)
lFromCount
must be less
than the lToCount
.lFromCount
- the custom num1 low rangelToCount
- the custom num1 high rangepublic void unsetCustomNum4()
public void setCustomStr1(java.lang.String sCustomStr1)
sCustomStr1
- the Custom String1setCustomStr1(String, boolean)
public void setCustomStr1(java.lang.String sCustomStr1, boolean bExactMatch)
sCustomStr1
- the custom str1bExactMatch
- true
for an exact match of the string custom str1; false
to match as substring custom str1public void setCustomStr1(java.lang.String[] customString1s)
customString1s
- the custom string1ssetCustomStr1(String[], boolean)
public void setCustomStr1(java.lang.String[] customString1s, boolean bExactMatch)
customString1s
- the custom string1sexact
- true
for an exact match of the custom string1s; false
to match a substringpublic void unsetCustomStr1()
public void setArchive(boolean bArchive)
bArchive
- the flag to filter by (true
to filter for archived forums; false
otherwise)public void unsetArchive()
public void setType(ForumType type)
type
- the forum type to filter by (may not be null
)public void setType(ForumType[] types)
types
- the forum types to filter by (may not be null
)public void unsetType()
public void setCustomStr2(java.lang.String sCustomStr2)
sCustomStr2
- the Custom String2setCustomStr2(String, boolean)
public void setCustomStr2(java.lang.String sCustomStr2, boolean bExactMatch)
sCustomStr2
- the custom str2bExactMatch
- true
for an exact match of the string custom str2; false
to match as substring custom str2public void setCustomStr2(java.lang.String[] customString2s)
customString2s
- the custom string2ssetCustomStr2(String[], boolean)
public void setCustomStr2(java.lang.String[] customString2s, boolean bExactMatch)
customString2s
- the custom string2sexact
- true
for an exact match of the custom string2s; false
to match a substringpublic void unsetCustomStr2()
public void setCustomStr3(java.lang.String sCustomStr3)
sCustomStr3
- the Custom String3setCustomStr3(String, boolean)
public void setCustomStr3(java.lang.String sCustomStr3, boolean bExactMatch)
sCustomStr3
- the custom str3bExactMatch
- true
for an exact match of the string custom str3; false
to match as substring custom str3public void setCustomStr3(java.lang.String[] customString3s)
customString3s
- the custom string3ssetCustomStr3(String[], boolean)
public void setCustomStr3(java.lang.String[] customString3s, boolean bExactMatch)
customString3s
- the custom string3sexact
- true
for an exact match of the custom string3s; false
to match a substringpublic void unsetCustomStr3()
public void setCustomStr4(java.lang.String sCustomStr4)
sCustomStr4
- the Custom String4setCustomStr4(String, boolean)
public void setCustomStr4(java.lang.String sCustomStr4, boolean bExactMatch)
sCustomStr4
- the custom str4bExactMatch
- true
for an exact match of the string custom str4; false
to match as substring custom str4public void setCustomStr4(java.lang.String[] customString4s)
customString4s
- the custom string4ssetCustomStr4(String[], boolean)
public void setCustomStr4(java.lang.String[] customString4s, boolean bExactMatch)
customString4s
- the custom string4sexact
- true
for an exact match of the custom string4s; false
to match a substringpublic void unsetCustomStr4()
public com.compoze.ejb.persistence.database.IFilterRule getFilterRule()
getFilterRule
in class AbstractFilter
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |