OSID Logo
OSID Specifications
calendaring rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.rules.CommitmentEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledCommitmentId
Description

Matches enablers mapped to the commitment.

Parametersosid.id.IdcommitmentIdthe commitment book Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT commitmentBookId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledCommitmentIdTerms
Description

Clears the commitment Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledCommitmentQuery
Description

Tests if a CommitmentBookQuery is available.

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

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

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

Matches enablers mapped to any commitment.

Parametersbooleanmatch true for enablers mapped to any commitment, false to match enablers mapped to no commitment
CompliancemandatoryThis method must be implemented.
MethodclearRuledCommitmentTerms
Description

Clears the commitment query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCalendarId
Description

Matches enablers mapped to the calendar.

Parametersosid.id.IdcalendarIdthe 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCalendarQuery
Description

Tests if an CalendarQuery is available.

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

Gets the query for an 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodgetCommitmentEnablerQueryRecord
Description

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

Parametersosid.type.TypecommitmentEnablerRecordTypea commitment enabler record type
Returnosid.calendaring.rules.records.CommitmentEnablerQueryRecordthe commitment enabler query record
ErrorsNULL_ARGUMENT commitmentEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commitmentEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.