| Interface | osid.ontology.SubjectSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
| ||
| Method | searchAmongSubjects | ||
| Description |
Execute this search among the given list of subjects. | ||
| Parameters | osid.id.IdList | subjectIds | list of subjects |
| Errors | NULL_ARGUMENT | subjectIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderSubjectResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.ontology.SubjectSearchOrder | subjectSearchOrder | subject search order |
| Errors | NULL_ARGUMENT | subjectSearchOrder is null | |
| UNSUPPORTED | subjectSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectSearchRecord | ||
| Description |
Gets the subject search record corresponding to the
given subject search record | ||
| Parameters | osid.type.Type | subjectSearchRecordType | a subject search record type |
| Return | osid.ontology.records.SubjectSearchRecord | the subject search record | |
| Errors | NULL_ARGUMENT | subjectSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(subjectSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |