OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.CommitmentQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching commitments. Each method match request produces an AND term while multiple invocations of a method produces 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.
MethodclearEventTerms
Description

Clears the event terms.

CompliancemandatoryThis method must be implemented.
MethodmatchResourceId
Description

Sets the resource Id for this query.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears the resource Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a ResourceQuery is available for querying resources.

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

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodclearResourceTerms
Description

Clears the resource terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCalendarId
Description

Sets the calendar Id for this query.

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.
MethodclearCalendarIdTerms
Description

Clears the calendar Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCalendarQuery
Description

Tests if a CalendarQuery is available for querying resources.

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

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

Returnosid.calendaring.CalendarQuerythe calendar query
ErrorsUNIMPLEMENTED supportsCalendarQuery() is false
ComplianceoptionalThis method must be implemented if supportsCalendarQuery() is true.
MethodclearCalendarTerms
Description

Clears the calendar terms.

CompliancemandatoryThis method must be implemented.
MethodgetCommitmentQueryRecord
Description

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

Parametersosid.type.TypecommitmentRecordTypea commitment query record type
Returnosid.calendaring.records.CommitmentQueryRecordthe commitment query record
ErrorsNULL_ARGUMENT commitmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commitmentRecordType) is false
CompliancemandatoryThis method must be implemented.