|
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.MessageFilter
This class represents a message filter. A message filter
is used to restrict the messages that are returned as
they are iterated over in a Messages
collection.
By setting properties in this filter, the messages that
are returned include only those messages with properties
that are the same. All string searches are a case-insensitive
substring search.
See the Messages
class for futher details and
examples on how to filter messages.
Fields inherited from class com.compoze.ebusiness.AbstractFilter |
m_rules, m_where |
Constructor Summary | |
MessageFilter()
Constructor. |
Method Summary | |
void |
appendFilter(MessageFilter 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 message filters appended to this filter. |
long[] |
getForums()
Gets the forums to filter by. |
void |
removeFilter(MessageFilter filter)
Removes the filter from this filter. |
void |
setApprovalStatus(ApprovalStatus status)
Sets the filtering by approval status. |
void |
setApprovalStatus(ApprovalStatus[] status)
Sets the filtering by approval status. |
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 |
setBody(java.lang.String sBody)
Sets filtering by body. |
void |
setBody(java.lang.String[] body)
Sets filtering by body. |
void |
setBody(java.lang.String[] body,
boolean bExactMatch)
Sets filtering by body. |
void |
setBody(java.lang.String sBody,
boolean bExactMatch)
sets filtering by body. |
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 |
setForum(long lForumID)
Sets the filtering by forum. |
void |
setForum(long[] forumIDs)
Sets the filtering by multiple forums. |
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 keyword. |
void |
setKeywords(java.lang.String sKeywords,
boolean bExactMatch)
sets filtering by keywords. |
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 |
setParentMessage(long lParentMessageID)
Sets the filtering by parent message id. |
void |
setParentMessage(long[] parentMessageIDs)
Sets the filtering by multiple parent messages. |
void |
setSubject(java.lang.String sSubject)
Sets filtering by subject. |
void |
setSubject(java.lang.String[] subjects)
Sets filtering by subject. |
void |
setSubject(java.lang.String[] subjects,
boolean bExactMatch)
Sets filtering by subject. |
void |
setSubject(java.lang.String sSubject,
boolean bExactMatch)
Sets filtering by subject. |
void |
setTopic(long lTopicID)
Sets the filtering by topic. |
void |
setTopic(long[] topicIDs)
Sets the filtering by multiple topics. |
void |
unsetApprovalStatus()
Unsets the filtering by approval status. |
void |
unsetAuthor()
Unsets filterting by author. |
void |
unsetBody()
Unsets filterting by body. |
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 |
unsetForum()
Unsets filtering by forum. |
void |
unsetKeyword()
Unsets filterting by keyword. |
void |
unsetMessageCount()
Unsets filtering by message count. |
void |
unsetParentMessage()
Unsets filtering by parent message. |
void |
unsetSubject()
Unsets filterting by subject. |
void |
unsetTopic()
Unsets filtering by topic. |
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 MessageFilter()
Method Detail |
public void appendFilter(MessageFilter filter, boolean bOr)
filter
- the filter the appendbOr
- true
to append this filter with an 'or'; false
to use 'and'public void removeFilter(MessageFilter filter)
filter
- the filter to removepublic void clearFilters()
public java.util.List getFilters()
MessageFilter
objectspublic void setSubject(java.lang.String sSubject)
sSubject
- the subjectsetSubject(String, boolean)
public void setSubject(java.lang.String sSubject, boolean bExactMatch)
sSubject
- the subjectbExactMatch
- true
for an exact match of the string subject; false
to match as substring subjectpublic void setSubject(java.lang.String[] subjects)
subjects
- the subjectssetSubject(String[], boolean)
public void setSubject(java.lang.String[] subjects, boolean bExactMatch)
subjects
- the subjectsexact
- true
for an exact match of the subjects; false
to match a substringpublic void unsetSubject()
public void setBody(java.lang.String sBody)
sBody
- the bodysetBody(String, boolean)
public void setBody(java.lang.String sBody, boolean bExactMatch)
sBody
- the bodybExactMatch
- true
for an exact match of the string body; false
to match as substring bodypublic void setBody(java.lang.String[] body)
body
- the bodysetBody(String[], boolean)
public void setBody(java.lang.String[] body, boolean bExactMatch)
body
- the bodyexact
- true
for an exact match of the body; false
to match a substringpublic void unsetBody()
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 body; false
to match a substringpublic void unsetKeyword()
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 setApprovalStatus(ApprovalStatus status)
status
- the status to filter by (may not be null
)public void setApprovalStatus(ApprovalStatus[] status)
status
- an array of approval status to filter by (may not be null
)public void unsetApprovalStatus()
public void setForum(long lForumID)
lForumID
- the forum id to filter bypublic void setForum(long[] forumIDs)
forumIDs
- an array of forum ids to filter bypublic void unsetForum()
public long[] getForums()
null
if not setpublic void setTopic(long lTopicID)
lTopicID
- the topic id to filter bypublic void setTopic(long[] topicIDs)
topicIDs
- an array of topic ids to filter bypublic void unsetTopic()
public void setParentMessage(long lParentMessageID)
lParentMessageID
- the parent message id to filter bypublic void setParentMessage(long[] parentMessageIDs)
parentMessageIDs
- an array of parent message ids to filter bypublic void unsetParentMessage()
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 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 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 |