|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.CalReportFilter
public class CalReportFilter
Used to restrict the results of a Report returned from the CalDAV server.
You can restrict results to only events within a specified time range (using StartDate
and EndDate
), to only recurring events within a specified time range
(using RecurStart
and RecurEnd
), and to events with an alarm set to go off within a specified time range. (using AlarmStart
and AlarmEnd
).
You can also restrict results to only those events which contain a specific Property
(either by property name, or name and a specific value). The EventType
field determines what kind of events are returned (events, todo lists, journal entries, or free/busy time).
AlarmEnd:
Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart
and AlarmEnd
.
The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.
AlarmStart:
Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart
and AlarmEnd
.
The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.
CustomFilter: Allows the user to specify his own filter XML. This property must be properly-formed XML, and must be a supported CalDAV filter or the bean throws an exception.
EndDate:
Limits the events returned in the report to only those which occur in the time range specified by StartDate
and EndDate
.
The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.
EventType: Indicates the type of calendar object resources to return in a Report. Some calendar servers (Google in particular) do not support vtAll , so you must submit a report for each type of event you wish to retrieve a report on.
Property:
Limits the events returned in a Report to only those which contain a matching property name and value.
For instance, setting the Property
filter to "ORGANIZER" will return only events that have an organizer specified. Setting the Property
filter to "ORGANIZER=mailto:JohnSmith@example.com" will return
only resources where "mailto:JohnSmith@example.com" is the specified organizer. Likewise, you can retrieve a report on a single event by setting the Property
filter with the UID of the needed resource. For
example: Property
= "UID=DC6C50A017428C5216A2F1CD@example.com";.
You may add multiple properties to the filter by separating them with commas. For example: "ORGANIZER=mailto:JohnSmith@example.com, STATUS=CANCELLED".
For more advanced filtering, you may specify your own CustomFilter
.
RecurEnd: Limits the recurring events returned in the report.
Use of the CalDAV limit-recurrence-set element causes the server to only return overridden recurrence components that overlap the time range specified by RecurStart
and RecurEnd
or that affect other instances that overlap the time range specified by StartDate
and EndDate
.
The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.
Note that the RecurEnd
field cannot be used when ReturnCalendarData
is False.
RecurStart: Limits the recurring events returned in the report.
Use of the CalDAV limit-recurrence-set element causes the server to only return overridden recurrence components that overlap the time range specified by RecurStart
and RecurEnd
or that affect other instances that overlap the time range specified by StartDate
and EndDate
.
The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.
Note that the RecurStart
field cannot be used when ReturnCalendarData
is False.
ReturnCalendarData: Controls whether the contents of each calendar event is returned in the report.
If ReturnCalendarData
is True (default), a report will contain the full contents of each event in the calendar.
This can be a substantially large amount of data. However if ReturnCalendarData
is False, the report returned will contain only URIs and ETags of each calendar event. You may compare the URIs against a cached list and retrieve any new URIs individually via the CalDAV. GetCalendarEvent method. If the ETag for a cached URI
has changed, it means that the calendar event has changed, and needs to be retrieved.
Note that this filter is not compatible with the RecurStart
and RecurEnd
fields.
StartDate:
Limits the events returned in the report to only those which occur in the time range specified
by StartDate
and EndDate
.
The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.
UID: Limits the recurring events returned in the report to only those with the specified UID.
Atom
,
Atom.CalReportFilter
Field Summary | |
---|---|
static int |
vtAll
|
static int |
vtEvent
|
static int |
vtFreeBusy
|
static int |
vtJournal
|
static int |
vtTodo
|
Constructor Summary | |
---|---|
CalReportFilter()
|
Method Summary | |
---|---|
java.lang.String |
getAlarmEnd()
|
java.lang.String |
getAlarmStart()
|
java.lang.String |
getCustomFilter()
|
java.lang.String |
getEndDate()
|
int |
getEventType()
|
java.lang.String |
getProperty()
|
java.lang.String |
getRecurEnd()
|
java.lang.String |
getRecurStart()
|
boolean |
getReturnCalendarData()
|
java.lang.String |
getStartDate()
|
java.lang.String |
getUID()
|
void |
setAlarmEnd(java.lang.String value)
|
void |
setAlarmStart(java.lang.String value)
|
void |
setCustomFilter(java.lang.String value)
|
void |
setEndDate(java.lang.String value)
|
void |
setEventType(int value)
|
void |
setProperty(java.lang.String value)
|
void |
setRecurEnd(java.lang.String value)
|
void |
setRecurStart(java.lang.String value)
|
void |
setReturnCalendarData(boolean value)
|
void |
setStartDate(java.lang.String value)
|
void |
setUID(java.lang.String value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int vtEvent
public static final int vtTodo
public static final int vtJournal
public static final int vtFreeBusy
public static final int vtAll
Constructor Detail |
---|
public CalReportFilter()
Method Detail |
---|
public java.lang.String getAlarmEnd()
public void setAlarmEnd(java.lang.String value)
public java.lang.String getAlarmStart()
public void setAlarmStart(java.lang.String value)
public java.lang.String getCustomFilter()
public void setCustomFilter(java.lang.String value)
public java.lang.String getEndDate()
public void setEndDate(java.lang.String value)
public int getEventType()
public void setEventType(int value)
public java.lang.String getProperty()
public void setProperty(java.lang.String value)
public java.lang.String getRecurEnd()
public void setRecurEnd(java.lang.String value)
public java.lang.String getRecurStart()
public void setRecurStart(java.lang.String value)
public boolean getReturnCalendarData()
public void setReturnCalendarData(boolean value)
public java.lang.String getStartDate()
public void setStartDate(java.lang.String value)
public java.lang.String getUID()
public void setUID(java.lang.String value)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |