OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.AcademyQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchConferralId
Description

Sets the conferral Id for this query to match conferrals assigned to academies.

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 conferral.

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

Matches academies with any conferral.

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

Clears the conferral terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAwardId
Description

Sets the award Id for this query to match conferrals assigned to awards.

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 academies with any award.

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

Clears the award terms.

CompliancemandatoryThis method must be implemented.
MethodmatchConvocationId
Description

Sets a convocaton Id.

Parametersosid.id.IdconvocationIda convocaton Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT convocationId is null
CompliancemandatoryThis method must be implemented.
MethodclearConvocationIdTerms
Description

Clears the convocaton Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsConvocationQuery
Description

Tests if a ConvocationQuery is available.

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

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

Returnosid.recognition.ConvocationQuerythe convocaton query
ErrorsUNIMPLEMENTED supportsConvocationQuery() is false
ComplianceoptionalThis method must be implemented if supportsConvocationQuery() is true.
MethodmatchAnyConvocation
Description

Matches any convocaton.

Parametersbooleanmatch true to match academies with any convocation, false to match academies with no convocations
CompliancemandatoryThis method must be implemented.
MethodclearConvocationTerms
Description

Clears the convocaton terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorAcademyId
Description

Sets the academy Id for this query to match academies that have the specified academy as an ancestor.

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

Clears the ancestor academy Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorAcademyQuery
Description

Tests if an AcademyQuery is available.

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

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

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

Matches academies with any ancestor.

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

Clears the ancestor academy terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantAcademyId
Description

Sets the academy Id for this query to match academies that have the specified academy as a descendant.

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

Clears the descendant academy Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantAcademyQuery
Description

Tests if an AcademyQuery is available.

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

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

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

Matches academies with any descendant.

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

Clears the descendant academy terms.

CompliancemandatoryThis method must be implemented.
MethodgetAcademyQueryRecord
Description

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

Parametersosid.type.TypeacademyRecordTypean academy record type
Returnosid.recognition.records.AcademyQueryRecordthe academy query record
ErrorsNULL_ARGUMENT academyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(academyRecordType) is false
CompliancemandatoryThis method must be implemented.