Interface | osid.learning.ProficiencySearchSession | ||
---|---|---|---|
Implements | osid.learning.ProficiencyQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Proficiencies may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getProficiencySearch | ||
Description |
Gets a proficiency search. | ||
Return | osid.learning.ProficiencySearch | the proficiency search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProficiencySearchOrder | ||
Description |
Gets a proficiency search order. The | ||
Return | osid.learning.ProficiencySearchOrder | the proficiency search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProficienciesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.learning.ProficiencyQuery | proficiencyQuery | the proficiency query |
osid.learning.ProficiencySearch | proficiencySearch | the proficiency search | |
Return | osid.learning.ProficiencySearchResults | the returned search results | |
Errors | NULL_ARGUMENT | proficiencyQuery or proficiencySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | proficiencyQuery or proficiencySearch is not
of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProficiencyQueryFromInspector | ||
Description |
Gets a proficiency query from an inspector. The
inspector is available from a | ||
Parameters | osid.learning.ProficiencyQueryInspector | proficiencyQueryInspector | a proficiency query inspector |
Return | osid.learning.ProficiencyQuery | the proficiency query | |
Errors | NULL_ARGUMENT | proficiencyQueryInspector is null | |
UNSUPPORTED | proficiencyQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |