|
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.calendar.AppointmentFilter
This class represents an appointment filter. An appointment filter
is used to restrict the appointments that are returned as
they are iterated over in a Appointments
collection.
By setting properties in this filter, the appointments that
are returned include only those appointments with properties
that are the same. The string filters are case-insensitive.
See the Appointments
class for futher details and
examples on how to filter appointments.
Appointments.setFilter(AppointmentFilter)
, Serialized FormFields inherited from class com.compoze.ebusiness.AbstractFilter |
m_rules, m_where |
Constructor Summary | |
AppointmentFilter()
Constructor. |
Method Summary | |
void |
appendFilter(AppointmentFilter filter,
boolean bOr)
Appends the filter to this filter. |
void |
clearFilters()
Clears all filter that are appended to this filter. |
java.util.Date |
getEndDate()
Gets the end date for the filter. |
com.compoze.ejb.persistence.database.IFilterRule |
getFilterRule()
|
java.util.List |
getFilters()
Gets a unmodifiable list of appointment filters appended to this filter. |
java.util.Date |
getStartDate()
Gets the start date for the filter. |
static void |
main(java.lang.String[] args)
Exerciser. |
void |
removeFilter(AppointmentFilter filter)
Removes the filter from this filter. |
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)
|
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 |
setDates(java.util.Calendar cal,
java.util.Date startDate,
java.util.Date endDate)
Sets the filtering by start and end date. |
void |
setDates(java.util.Date startDate,
java.util.Date endDate)
Sets the filtering by start and end date. |
void |
setDay(java.util.Calendar cal)
Sets the start and end date properties to include all appointments in the day of the specified date. |
void |
setDay(java.util.Calendar cal,
int iYear,
int iMonth,
int iDayOfMonth)
Sets the start and end date properties to include all appointments in the specified day. |
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 descriptions. |
void |
setDescription(java.lang.String sDescription,
boolean bExactMatch)
Sets filtering by description. |
void |
setMonth(java.util.Calendar cal)
Sets the start and end date properties to include all appointments in the month of the specified date. |
void |
setMonth(java.util.Calendar cal,
int iYear,
int iMonth)
Sets the start and end date properties to include all appointments in the specified month. |
void |
setSummary(java.lang.String sSummary)
Sets filtering by summary. |
void |
setSummary(java.lang.String[] summaries)
Sets filtering by summary. |
void |
setSummary(java.lang.String[] summaries,
boolean bExactMatch)
Sets filtering by summaries. |
void |
setSummary(java.lang.String sSummary,
boolean bExactMatch)
Sets filtering by summary. |
void |
setWeek(java.util.Calendar cal)
Sets the start and end date properties to include all appointments in the week of the specified date. |
void |
setWeek(java.util.Calendar cal,
int iYear,
int iMonth,
int iWeek)
Sets the start and end date properties to include all appointments in the specified week. |
void |
setWorkWeek(java.util.Calendar cal)
Sets the start and end date properties to include all appointments that occur during the work week (M-F) of the specified date. |
void |
setYear(java.util.Calendar cal)
Sets the start and end date properties to include all appointments in the year of the specified Calendar . |
void |
setYear(java.util.Calendar cal,
int iYear)
Sets the start and end date properties to include all appointments in the specified year. |
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 |
unsetDates()
Unsets filterting by end date. |
void |
unsetDescription()
Unsets filterting by descriptions. |
void |
unsetSummary()
Unsets filterting by summaries. |
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 AppointmentFilter()
Method Detail |
public void appendFilter(AppointmentFilter filter, boolean bOr)
filter
- the filter the appendbOr
- true
to append this filter with an 'or'; false
to use 'and'public void removeFilter(AppointmentFilter filter)
filter
- the filter to removepublic void clearFilters()
public java.util.List getFilters()
AppointmentFilter
objectspublic 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)
public 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 void setSummary(java.lang.String sSummary)
sSummary
- the summarysetSummary(String, boolean)
public void setSummary(java.lang.String sSummary, boolean bExactMatch)
sSummary
- the summarybExactMatch
- true
for an exact match of the string summary; false
to match as substring summarypublic void setSummary(java.lang.String[] summaries)
summaries
- the summariessetSummary(String[], boolean)
public void setSummary(java.lang.String[] summaries, boolean bExactMatch)
summaries
- the summariesexact
- true
for an exact match of the summaries; false
to match a substringpublic void unsetSummary()
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 setDates(java.util.Date startDate, java.util.Date endDate)
Calendar.getInstance()
is used for the system-wide default calendar.startDate
- the starting date (may not be null
)endDate
- the ending date (may not be null
)public void setDates(java.util.Calendar cal, java.util.Date startDate, java.util.Date endDate)
cal
- the calendar to use to calculate the dates
(pass in Calendar.getInstance()
for the system-wide default, but you probably
want to use the user's calendar set to their
locale and time zone)startDate
- the starting date (may not be null
)endDate
- the ending date (may not be null
)public void unsetDates()
public java.util.Date getStartDate()
null
if no start date rule is setpublic java.util.Date getEndDate()
null
if no end date rule is setpublic void setYear(java.util.Calendar cal, int iYear)
cal
- the calendar to use to calculate the dates
(pass in Calendar.getInstance()
for the system-wide default, but you probably
want to use the user's calendar set to their
locale and time zone)iYear
- the year (the calendar is first set to this year)public void setYear(java.util.Calendar cal)
Calendar
.cal
- a calendar set to the desired yearpublic void setMonth(java.util.Calendar cal, int iYear, int iMonth)
cal
- the calendar to use to calculate the dates
(pass in Calendar.getInstance()
for the system-wide default, but you probably
want to use the user's calendar set to their
locale and time zone)iYear
- the year (the calendar is first set to this year)iMonth
- the month (the calendar is first set to this
month, see month constants in
java.util.Calendar
)public void setMonth(java.util.Calendar cal)
cal
- a calendar set to the desired monthpublic void setWeek(java.util.Calendar cal, int iYear, int iMonth, int iWeek)
cal
- the calendar to use to calculate the dates
(pass in Calendar.getInstance()
for the system-wide default, but you probably
want to use the user's calendar set to their
locale and time zone)iYear
- the year (the calendar is first set to this year)iMonth
- the month (the calendar is first set to this month,
see month constants in java.util.Calendar
)iWeekOfMonth
- the week of the month (the calendar is first
set to this week of the month)public void setWeek(java.util.Calendar cal)
cal
- a calendar set to the desired weekpublic void setWorkWeek(java.util.Calendar cal)
cal
- a calendar set to the desired datepublic void setDay(java.util.Calendar cal, int iYear, int iMonth, int iDayOfMonth)
cal
- the calendar to use to calculate the dates
(pass in Calendar.getInstance()
for the system-wide default, but you probably
want to use the user's calendar set to their
locale and time zone)iYear
- the year (the calendar is first set to this year)iMonth
- the month (see month constants in
java.util.Calendar
)iDayOfMonth
- the day of the month (the calendar is first set
to this day of the month)public void setDay(java.util.Calendar cal)
cal
- a calendar set to the desired datepublic com.compoze.ejb.persistence.database.IFilterRule getFilterRule()
getFilterRule
in class AbstractFilter
public static void main(java.lang.String[] args)
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |