Interface | osid.learning.ProficiencyQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching proficiencies. Each method
match specifies an | ||
Method | matchResourceId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQuery | ||
Description |
Gets the query for a resource. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | clearResourceTerms | ||
Description |
Clears the resource terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchObjectiveId | ||
Description |
Sets the objective | ||
Parameters | osid.id.Id | objectiveId | an objective Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | objectiveId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearObjectiveIdTerms | ||
Description |
Clears the objective | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsObjectiveQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an robjective query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveQuery | ||
Description |
Gets the query for an objective. Multiple retrievals
produce a nested | ||
Return | osid.learning.ObjectiveQuery | the objective query | |
Errors | UNIMPLEMENTED | supportsObjectiveQuery() is false | |
Compliance | optional | This method must be implemented if supportsObjectiveQuery()
is true. | |
Method | matchAnyObjective | ||
Description |
Matches an activity that has any objective assigned. | ||
Parameters | boolean | match | true to match activities with any objective, false
to match activities with no objective |
Compliance | mandatory | This method must be implemented. | |
Method | clearObjectiveTerms | ||
Description |
Clears the objective terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCompletion | ||
Description |
Sets the completion for this query to match completion percentages between the given range inclusive. | ||
Parameters | decimal | start | start of range |
decimal | end | end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | end is less than start | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCompletionTerms | ||
Description |
Clears the completion terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumCompletion | ||
Description |
Sets the minimum completion for this query. | ||
Parameters | decimal | completion | completion percentage |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumCompletionTerms | ||
Description |
Clears the minimum completion terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLevelId | ||
Description |
Sets the level grade | ||
Parameters | osid.id.Id | gradeId | a grade Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearLevelIdTerms | ||
Description |
Clears all level | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsLevelQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLevelQuery | ||
Description |
Gets the query for a grade. Multiple retrievals produce
a nested | ||
Return | osid.grading.GradeQuery | the grade query | |
Errors | UNIMPLEMENTED | supportsLevelQuery() is false | |
Compliance | optional | This method must be implemented if supportsLevelQuery() is
true. | |
Method | matchAnyLevel | ||
Description |
Matches an assessment offered that has any level assigned. | ||
Parameters | boolean | match | true to match offerings with any level, false
to match offerings with no levsls |
Compliance | mandatory | This method must be implemented. | |
Method | clearLevelTerms | ||
Description |
Clears all level terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchObjectiveBankId | ||
Description |
Sets the objective bank | ||
Parameters | osid.id.Id | objectiveBankId | an objective bank Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | objectiveBankId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearObjectiveBankIdTerms | ||
Description |
Clears the objective bank | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsObjectiveBankQuery | ||
Description |
Tests if a | ||
Return | boolean | true if an objective bank query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveBankQuery | ||
Description |
Gets the query for an objective bank. Multiple
retrievals produce a nested | ||
Return | osid.learning.ObjectiveBankQuery | the objective bank query | |
Errors | UNIMPLEMENTED | supportsObjectiveBankQuery() is false | |
Compliance | optional | This method must be implemented if supportsObjectiveBankQuery()
is true. | |
Method | clearObjectiveBankTerms | ||
Description |
Clears the objective bank terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProficiencyQueryRecord | ||
Description |
Gets the proficiency query record corresponding to the
given | ||
Parameters | osid.type.Type | proficiencyRecordType | a proficiency offered record type |
Return | osid.learning.records.ProficiencyQueryRecord | the proficiency offered query record | |
Errors | NULL_ARGUMENT | proficiencyOfferedRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(proficiencyOfferedRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |