Calendar.Search

Retrieves calendar items (appointments, notes, and tasks) that match the specified criteria.

Parameters

Calendar.queryCount

Specifies how many calendar items to retrieve.

Calendar.startDate

Specifies the start date to use for the calendar query (as the number of milliseconds since 12:00.00 a.m. on January 1, 1970). The default is the current time. This value is not used if Calendar.queryDate is specified or if Calendar.queryType=Calendar.queryDate.

Calendar.dateFormat

(Optional) Specifies the format that the startDate and endDate are in. It must be a valid string pattern as accepted by the Java SimpleDateFormat class.

Calendar.queryType

Specifies the type of calendar search. The default is the current day. Other valid values include the following:

Calendar.nextDay

The next day relative to Calendar.startDate.

Calendar.nextWeek

The next week relative to Calendar.startDate.

Calendar.nextMonth

The next month relative to Calendar.startDate.

Calendar.nextYear

The next year relative to Calendar.startDate.

Calendar.prevDay

The previous day relative to Calendar.startDate.

Calendar.prevWeek

The previous week relative to Calendar.startDate.

Calendar.prevMonth

The previous month relative to Calendar.startDate.

Calendar.nextYear

The next year relative to Calendar.startDate.

Calendar.queryDate

A specific date is desired. If specified, the following parameters must also be specified:

Calendar.queryDay, Calendar.queryMonth, and Calendar.queryYear.
Calendar.queryDate

Specifies that a specific date is desired. This value is ignored if Calendar.queryType is specified. The value of this parameter is ignored. If Calendar.queryDate is specified, the following parameters must be present:

  • Calendar.queryDay
  • Calendar.queryMonth
  • Calendar.queryYear
Calendar.queryDay

Specifies the desired day of the month.

Calendar.queryMonth

Specifies the desired month of the year (1 = January, 12 = December).

Calendar.queryYear

Specifies the desired year (in four-digit format, such as 1999 or 2000).

Calendar.nextDay

Specifies the day after the day specified by Calendar.startDate. The current date is used if Calendar.startDate is not specified.

Calendar.nextWeek

Specifies the day one week after the day specified by Calendar.startDate. The current date is used if Calendar.startDate is not specified.

Calendar.nextMonth

Specifies the month one month after the day specified by Calendar.startDate. The current date is used if Calendar.startDate is not specified.

Calendar.nextYear

Specifies the day one year after the day specified by Calendar.startDate. The current date is used if Calendar.startDate is not specified.

Calendar.prevDay

Specifies the day before the day specified by Calendar.startDate The current date is used if Calendar.startDate is not specified.

Calendar.prevWeek

Specifies the day one week before the day specified by Calendar.startDate The current date is used if Calendar.startDate is not specified.

Calendar.prevMonth

Specifies the day one month before the day specified by Calendar.startDate The current date is used if Calendar.startDate is not specified.

Calendar.prevYear

Specifies the day one year before the day specified by Calendar.startDate The current date is used if Calendar.startDate is not specified.

Calendar.endDate

Specifies the time (or the number of milliseconds since 12:00.00 a.m. January 1, 1970) after which to stop retrieving items.

Calendar.durationType

Specifies the time duration for which items should be retrieved (ignored if Calendar.endDate is specified):

  • Day Returns items for one day (Default)
  • Week Returns items for one week
  • Month Returns items for one month
Calendar.queryMessageType

Specifies the type of messages to retrieve (defaults to receive all appointments, notes, and tasks):

  • Appointment
  • Note
  • Task
User.context (Required)

Specifies the context identifier for this user's session.

Return Values

Value

Description

Calendar.firstDayOfWeek

Day of the week that the month of the starting date falls on (1 = Sunday, 2 = Monday, . . . 7 = Saturday).

Calendar.dayCount

Number of days in the month of the starting date.

Calendar.endDate

Ending date (represents the number of milliseconds since 12:00.00 a.m. January 1, 1970).

Calendar.startDate

Starting date (represents the number of milliseconds since 12:00.00 a.m. January 1, 1970).

Folder.hasMore

1 = There are more messages than what was returned.

Item.count

Number of items returned.

Item[n].id

nth item within the list of items returned.

Item[n].drn

GroupWise identifier of the nth item returned.

Item[n].type

Type of the nth item: Appointment, Note, or Task.

Item[n].priority

Priority of the nth item.

Item[n].from

Sender of the nth item.

Item[n].told

List of user identifiers to whom the nth item was sent.

Item[n].subject

Subject of the nth item.

Item[n].subType

Subtype of the nth item:

  • Item.SHARED_ADDRESS_BOOK
  • Item.PERSONAL
  • Item.SHARED_FOLDER
  • Item.DISCUSSION
  • Item.WORKFLOW
  • Item.REPLY_REQUESTED

Item[n].Status.read

Read or unread.

Item[n].Status.accepted

Accepted or unaccepted.

Item[n].Status.completed

Completed or uncompleted.

Item[n].dateSent

Date the nth item was sent.

Item[n].dateStart

Start time for the nth item (for calendar items).

Item[n].dateEnd

End time for the nth item (for appointments, due date for tasks).

Item[n].location

Location of the nth item (for appointments).

Item[n].isOutbound

nth item is a sent item.

Item[n].Priority.task

Priority of the nth item.

Item[n].dateTaskAssigned

Assigned date for the nth item (for tasks).

Item[n].hasAttachment

1 = nth item has attachments.

Folder.hasInbound

1 = returned list of items contains received items.

Folder.hasOutbound

1 = returned list of items contains send items.

Example

<! Search for today’s calendar items >
<A href="/servlet/webacc?User.context=xyz&action=Calendar.Search">Today</A>

<! Search for tomorrow’s calendar items >
<A href="/servlet
webacc?User.context=xyz&action=Calendar.Search&queryType=Calendar.queryNext">Tomorrow</A>

<! Search for Calendar Items for 3 January 2000 >
<A href="/servlet
webacc?User.context=xyz&action=Calendar.Search&Calendar.queryType=queryDate&Calendar.queryDa
=3&Calendar.queryMonth=1&Calendar.queryYear=2000">January 3, 2000</A>
<! OR >
<A href="/servlet/webacc?User.context=xyz&action=Calendar.Search&Calendar.
QueryDate=&Calendar.queryDay=3&Calendar.queryMonth=1&Calendar.queryYear=2000">January 3, 2000</A>