Interface | osid.recognition.AcademyQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching for academies. Each method
specifies an | ||
Method | matchConferralId | ||
Description |
Sets the conferral | ||
Parameters | osid.id.Id | conferralId | a conferral Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | conferralId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearConferralIdTerms | ||
Description |
Clears the conferral | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsConferralQuery | ||
Description |
Tests if a conferral query is available. | ||
Return | boolean | true if a conferral query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getConferralQuery | ||
Description |
Gets the query for an conferral. | ||
Return | osid.recognition.ConferralQuery | the conferral query | |
Errors | UNIMPLEMENTED | supportsConferralQuery() is false | |
Compliance | optional | This method must be implemented if supportsConferralQuery()
is true. | |
Method | matchAnyConferral | ||
Description |
Matches academies with any conferral. | ||
Parameters | boolean | match | true to match academies with any conferral, false
to match academies with no conferrals |
Compliance | mandatory | This method must be implemented. | |
Method | clearConferralTerms | ||
Description |
Clears the conferral terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAwardId | ||
Description |
Sets the award | ||
Parameters | osid.id.Id | awardId | an award Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | awardId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAwardIdTerms | ||
Description |
Clears the award | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAwardQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an award query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardQuery | ||
Description |
Gets the query for an award query. Multiple retrievals
produce a nested | ||
Return | osid.recognition.AwardQuery | the award query | |
Errors | UNIMPLEMENTED | supportsAwardQuery() is false | |
Compliance | optional | This method must be implemented if supportsAwardQuery() is
true. | |
Method | matchAnyAward | ||
Description |
Matches academies with any award. | ||
Parameters | boolean | match | true to match academies with any award, false
to match academies with no awards |
Compliance | mandatory | This method must be implemented. | |
Method | clearAwardTerms | ||
Description |
Clears the award terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchConvocationId | ||
Description |
Sets a convocaton | ||
Parameters | osid.id.Id | convocationId | a convocaton Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | convocationId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearConvocationIdTerms | ||
Description |
Clears the convocaton | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsConvocationQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a convocaton query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getConvocationQuery | ||
Description |
Gets the query for a convocaton query. Multiple
retrievals produce a nested | ||
Return | osid.recognition.ConvocationQuery | the convocaton query | |
Errors | UNIMPLEMENTED | supportsConvocationQuery() is false | |
Compliance | optional | This method must be implemented if supportsConvocationQuery()
is true. | |
Method | matchAnyConvocation | ||
Description |
Matches any convocaton. | ||
Parameters | boolean | match | true to match academies with any convocation, false
to match academies with no convocations |
Compliance | mandatory | This method must be implemented. | |
Method | clearConvocationTerms | ||
Description |
Clears the convocaton terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorAcademyId | ||
Description |
Sets the academy | ||
Parameters | osid.id.Id | academyId | an academy Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | academyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorAcademyIdTerms | ||
Description |
Clears the ancestor academy | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorAcademyQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an academy query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorAcademyQuery | ||
Description |
Gets the query for an academy. Multiple retrievals
produce a nested | ||
Return | osid.recognition.AcademyQuery | the academy query | |
Errors | UNIMPLEMENTED | supportsAncestorAcademyQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorAcademyQuery()
is true. | |
Method | matchAnyAncestorAcademy | ||
Description |
Matches academies with any ancestor. | ||
Parameters | boolean | match | true to match academies with any ancestor, false
to match root academies |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorAcademyTerms | ||
Description |
Clears the ancestor academy terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantAcademyId | ||
Description |
Sets the academy | ||
Parameters | osid.id.Id | academyId | an academy Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | academyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantAcademyIdTerms | ||
Description |
Clears the descendant academy | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantAcademyQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an academy query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantAcademyQuery | ||
Description |
Gets the query for an academy. Multiple retrievals
produce a nested | ||
Return | osid.recognition.AcademyQuery | the academy query | |
Errors | UNIMPLEMENTED | supportsDescendantAcademyQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantAcademyQuery()
is true. | |
Method | matchAnyDescendantAcademy | ||
Description |
Matches academies with any descendant. | ||
Parameters | boolean | match | true to match academies with any descendant, false
to match leaf academies |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantAcademyTerms | ||
Description |
Clears the descendant academy terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademyQueryRecord | ||
Description |
Gets the query record corresponding to the given | ||
Parameters | osid.type.Type | academyRecordType | an academy record type |
Return | osid.recognition.records.AcademyQueryRecord | the academy query record | |
Errors | NULL_ARGUMENT | academyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(academyRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |