OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConvocationQuery
Implementsosid.OsidGovernatorQuery
Description

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

MethodmatchAwardId
Description

Sets an award Id.

Parametersosid.id.IdawardIdan award Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT awardId is null
CompliancemandatoryThis method must be implemented.
MethodclearAwardIdTerms
Description

Clears the award Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAwardQuery
Description

Tests if an AwardQuery is available.

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

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

Returnosid.recognition.AwardQuerythe award query
ErrorsUNIMPLEMENTED supportsAwardQuery() is false
ComplianceoptionalThis method must be implemented if supportsAwardQuery() is true.
MethodmatchAnyAward
Description

Matches convocations with any award.

Parametersbooleanmatch true to match convocations with any award, false to match convocations with no awards
CompliancemandatoryThis method must be implemented.
MethodclearAwardTerms
Description

Clears the award terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDate
Description

Matches the date between the given dates inclusive.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyDate
Description

Matches convocations with any date.

Parametersbooleanmatch true to match convocations with any date, false to match convocations with no date
CompliancemandatoryThis method must be implemented.
MethodclearDateTerms
Description

Clears the date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimePeriodId
Description

Sets a time period Id.

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 query. Multiple retrievals produce a nested OR term.

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

Matches any time period.

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

Clears the time period terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConferralId
Description

Sets the conferral Id for this query.

Parametersosid.id.IdconferralIda conferral Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT conferralId is null
CompliancemandatoryThis method must be implemented.
MethodclearConferralIdTerms
Description

Clears the conferral Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsConferralQuery
Description

Tests if a conferral query is available.

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

Gets the query for an award.

Returnosid.recognition.ConferralQuerythe conferral query
ErrorsUNIMPLEMENTED supportsConferralQuery() is false
ComplianceoptionalThis method must be implemented if supportsConferralQuery() is true.
MethodmatchAnyConferral
Description

Matches convocations with any conferral.

Parametersbooleanmatch true to match convocations with any conferral, false to match convocations with no conferrals
CompliancemandatoryThis method must be implemented.
MethodclearConferralTerms
Description

Clears the conferral terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAcademyId
Description

Sets the award Id for this query to match convocations assigned to academies.

Parametersosid.id.IdacademyIdan academy Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT academyId is null
CompliancemandatoryThis method must be implemented.
MethodclearAcademyIdTerms
Description

Clears the academy Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAcademyQuery
Description

Tests if an AcademyQuery is available.

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

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

Returnosid.recognition.AcademyQuerythe academy query
ErrorsUNIMPLEMENTED supportsAcademyQuery() is false
ComplianceoptionalThis method must be implemented if supportsAcademyQuery() is true.
MethodclearAcademyTerms
Description

Clears the academy terms.

CompliancemandatoryThis method must be implemented.
MethodgetConvocationQueryRecord
Description

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

Parametersosid.type.TypeconvocationRecordTypea convocation record type
Returnosid.recognition.records.ConvocationQueryRecordthe convocation query record
ErrorsNULL_ARGUMENT convocationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(convocationRecordType) is false
CompliancemandatoryThis method must be implemented.