Interface | osid.recognition.ConferralQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching conferrals. Each method
specifies an | ||
Method | matchAwardId | ||
Description |
Sets an 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 | clearAwardTerms | ||
Description |
Clears the award terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRecipientId | ||
Description |
Sets a resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRecipientIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipientQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipientQuery | ||
Description |
Gets the query for a resource query. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsRecipientQuery() is false | |
Compliance | optional | This method must be implemented if supportsRecipientQuery()
is true. | |
Method | clearRecipientTerms | ||
Description |
Clears the resource terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchReferenceId | ||
Description |
Sets a reference | ||
Parameters | osid.id.Id | referenceId | a reference Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | referenceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyReferenceId | ||
Description |
Matches any reference. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearReferenceIdTerms | ||
Description |
Clears the reference | ||
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 for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearConvocationTerms | ||
Description |
Clears the convocaton terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAcademyId | ||
Description |
Sets the award | ||
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 | clearAcademyIdTerms | ||
Description |
Clears the academy | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAcademyQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an academy query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAcademyQuery | ||
Description |
Gets the query for an academy query. Multiple
retrievals produce a nested | ||
Return | osid.recognition.AcademyQuery | the academy query | |
Errors | UNIMPLEMENTED | supportsAcademyQuery() is false | |
Compliance | optional | This method must be implemented if supportsAcademyQuery() is
true. | |
Method | clearAcademyTerms | ||
Description |
Clears the academy terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConferralQueryRecord | ||
Description |
Gets the conferral query record corresponding to the
given | ||
Parameters | osid.type.Type | conferralRecordType | a conferral record type |
Return | osid.recognition.records.ConferralQueryRecord | the conferral query record | |
Errors | NULL_ARGUMENT | conferralRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(conferralRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |