org.unitedinternet.cosmo.model.filter

Class EventStampFilter

java.lang.Object

org.unitedinternet.cosmo.model.filter.StampFilter

org.unitedinternet.cosmo.model.filter.EventStampFilter

public class EventStampFilter
extends StampFilter

Adds EventStamp specific criteria to StampFilter. Matches only EventStamp instances.

The following filter properties are supported:

• PROPERTY_INCLUDE_MASTER_ITEMS - If set to "false", and there is a timeRange specified in the filter, then master items that match the timeRange will not be included in the results. This is used to only return occurrences and modifications of a recurring event, but not the master event item.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_DO_TIMERANGE_SECOND_PASS
static String	PROPERTY_INCLUDE_MASTER_ITEMS

Constructor Summary

Constructors

Constructor and Description
EventStampFilter()

Method Summary

Modifier and Type	Method and Description
String	getFloatEnd()
String	getFloatEnd(String dateTimeFormat)
String	getFloatStart()
String	getFloatStart(String dateTimeFormat)
Boolean	getIsRecurring()
net.fortuna.ical4j.model.Period	getPeriod()
net.fortuna.ical4j.model.TimeZone	getTimezone()
String	getUTCEnd()
String	getUTCEnd(String dateTimeFormat)
String	getUTCStart()
String	getUTCStart(String dateTimeFormat)
boolean	isExpandRecurringEvents()
void	setExpandRecurringEvents(boolean expandRecurringEvents) If a time-range query is specified, the filter can be configured to expand recurring events within the time range.
void	setIsRecurring(Boolean isRecurring) Match only recurring events.
void	setPeriod(net.fortuna.ical4j.model.Period period) Matches events that occur in a given time-range.
void	setTimeRange(Date start, Date end) Matches events that occur in a given time-range.
void	setTimezone(net.fortuna.ical4j.model.TimeZone timezone) Used in time-range filtering.

Methods inherited from class org.unitedinternet.cosmo.model.filter.StampFilter

getStampClass, isMissing, setMissing, setStampClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_INCLUDE_MASTER_ITEMS

public static final String PROPERTY_INCLUDE_MASTER_ITEMS

See Also:

Constant Field Values

PROPERTY_DO_TIMERANGE_SECOND_PASS

public static final String PROPERTY_DO_TIMERANGE_SECOND_PASS

See Also:

Constant Field Values

Constructor Detail

EventStampFilter

public EventStampFilter()

Method Detail

getPeriod

public net.fortuna.ical4j.model.Period getPeriod()

setPeriod

public void setPeriod(net.fortuna.ical4j.model.Period period)

Matches events that occur in a given time-range.

Parameters:

period - time-range

setTimeRange

public void setTimeRange(Date start,
                         Date end)

Matches events that occur in a given time-range.

Parameters:

start - range start

end - range end

getUTCStart

public String getUTCStart()

getUTCStart

public String getUTCStart(String dateTimeFormat)

getUTCEnd

public String getUTCEnd()

getUTCEnd

public String getUTCEnd(String dateTimeFormat)

getFloatStart

public String getFloatStart(String dateTimeFormat)

getFloatStart

public String getFloatStart()

getFloatEnd

public String getFloatEnd()

getFloatEnd

public String getFloatEnd(String dateTimeFormat)

isExpandRecurringEvents

public boolean isExpandRecurringEvents()

setExpandRecurringEvents

public void setExpandRecurringEvents(boolean expandRecurringEvents)

If a time-range query is specified, the filter can be configured to expand recurring events within the time range. This results in a NoteOccurrence item returned for each occurrence of a matching recurring event during the specified time range.

Parameters:

expandRecurringEvents - if true and a time-range is specified, return a NoteOccurrence for each occurence of a recurring event during the time-range.

getTimezone

public net.fortuna.ical4j.model.TimeZone getTimezone()

setTimezone

public void setTimezone(net.fortuna.ical4j.model.TimeZone timezone)

Used in time-range filtering. If set, and there is a time-range to filter on, the timezone will be used in comparing floating times. If null, the server time-zone will be used in determining if floating time values match.

Parameters:

timezone - timezone to use in comparing floating times

getIsRecurring

public Boolean getIsRecurring()

setIsRecurring

public void setIsRecurring(Boolean isRecurring)

Match only recurring events.

Parameters:

isRecurring - if set, return recurring events only, or only non recurring events