OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConferralQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching conferrals. 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.
MethodclearAwardTerms
Description

Clears the award terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRecipientId
Description

Sets a resource Id.

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

Clears the resource Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRecipientQuery
Description

Tests if a ResourceQuery is available.

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

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

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

Clears the resource terms.

CompliancemandatoryThis method must be implemented.
MethodmatchReferenceId
Description

Sets a reference Id.

Parametersosid.id.IdreferenceIda reference Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT referenceId is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyReferenceId
Description

Matches any reference.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearReferenceIdTerms
Description

Clears the reference Id 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 for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearConvocationTerms
Description

Clears the convocaton terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAcademyId
Description

Sets the award Id for this query to match conferrals 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.
MethodgetConferralQueryRecord
Description

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

Parametersosid.type.TypeconferralRecordTypea conferral record type
Returnosid.recognition.records.ConferralQueryRecordthe conferral query record
ErrorsNULL_ARGUMENT conferralRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(conferralRecordType) is false
CompliancemandatoryThis method must be implemented.