OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.CalendarQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching calendars. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchEventId
Description

Sets the event Id for this query.

Parametersosid.id.IdeventIdan event Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearEventIdTerms
Description

Clears the event Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEventQuery
Description

Tests if an EventQuery is available.

Returnboolean true if an event query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEventQuery
Description

Gets the query for an event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.EventQuerythe event query
ErrorsUNIMPLEMENTED supportsEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsEventQuery() is true.
MethodmatchAnyEvent
Description

Matches a calendar that has any event assigned.

Parametersbooleanmatch true to match calendars with any event, false to match calendars with no events
CompliancemandatoryThis method must be implemented.
MethodclearEventTerms
Description

Clears the event terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimePeriodId
Description

Sets the time period Id for this query.

Parametersosid.id.IdtimePeriodIda time period Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT timePeriodId is null
CompliancemandatoryThis method must be implemented.
MethodclearTimePeriodIdTerms
Description

Clears the time period Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTimePeriodQuery
Description

Tests if a TimePeriodQuery is available.

Returnboolean true if a time period query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodQuery
Description

Gets the query for a time period. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.TimePeriodQuerythe tiem period query
ErrorsUNIMPLEMENTED supportsTimePeriodQuery() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodQuery() is true.
MethodmatchAnyTimePeriod
Description

Matches a calendar that has any time period assigned.

Parametersbooleanmatch true to match calendars with any time period, false to match calendars with no time periods
CompliancemandatoryThis method must be implemented.
MethodclearTimePeriodTerms
Description

Clears the time period terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCommitmentId
Description

Sets the commitment Id for this query.

Parametersosid.id.IdcommitmentIda commitment Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT commitmentId is null
CompliancemandatoryThis method must be implemented.
MethodclearCommitmentIdTerms
Description

Clears the commitment Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCommitmentQuery
Description

Tests if a CommitmentQuery is available.

Returnboolean true if a commitment query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentQuery
Description

Gets the query for a commitment. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.CommitmentQuerythe commitment query
ErrorsUNIMPLEMENTED supportsCommitmentQuery() is false
ComplianceoptionalThis method must be implemented if supportsCommitmentQuery() is true.
MethodmatchAnyCommitment
Description

Matches a calendar that has any event commitment.

Parametersbooleanmatch true to match calendars with any commitment, false to match calendars with no commitments
CompliancemandatoryThis method must be implemented.
MethodclearCommitmentTerms
Description

Clears the commitment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorCalendarId
Description

Sets the calendar Id for this query to match calendars that have the specified calendar as an ancestor.

Parametersosid.id.IdcalendarIda calendar Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT calendarId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorCalendarIdTerms
Description

Clears the ancestor calendar Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorCalendarQuery
Description

Tests if a CalendarQuery is available.

Returnboolean true if a calendar query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorCalendarQuery
Description

Gets the query for a calendar. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.CalendarQuerythe calendar query
ErrorsUNIMPLEMENTED supportsAncestorCalendarQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorCalndarQuery() is true.
MethodmatchAnyAncestorCalendar
Description

Matches a calendar that has any ancestor.

Parametersbooleanmatch true to match calendars with any ancestor, false to match root calendars
CompliancemandatoryThis method must be implemented.
MethodclearAncestorCalendarTerms
Description

Clears the ancestor calendar terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantCalendarId
Description

Sets the calendar Id for this query to match calendars that have the specified calendar as a descendant.

Parametersosid.id.IdcalendarIda calendar Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT calendarId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantCalendarIdTerms
Description

Clears the descendant calendar Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantCalendarQuery
Description

Tests if a CalendarQuery.

Returnboolean true if a calendar query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantCalendarQuery
Description

Gets the query for a calendar. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.CalendarQuerythe calendar query
ErrorsUNIMPLEMENTED supportsDescendantCalendarQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantCalndarQuery() is true.
MethodmatchAnyDescendantCalendar
Description

Matches a calendar that has any descendant.

Parametersbooleanmatch true to match calendars with any descendant, false to match leaf calendars
CompliancemandatoryThis method must be implemented.
MethodclearDescendantCalendarTerms
Description

Clears the descendant calendar terms.

CompliancemandatoryThis method must be implemented.
MethodgetCalendarQueryRecord
Description

Gets the calendar query record corresponding to the given Calendar record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypecalendarRecordTypea calendar record type
Returnosid.calendaring.records.CalendarQueryRecordthe calendar query record
ErrorsNULL_ARGUMENT calendarRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(calendarRecordType) is false
CompliancemandatoryThis method must be implemented.