| Interface | osid.ontology.SubjectSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getSubjects | ||
| Description |
Gets the subject list resulting from the search. | ||
| Return | osid.ontology.SubjectList | the subject list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.ontology.SubjectQueryInspector | the subject query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectSearchResultsRecord | ||
| Description |
Gets the subject search results record corresponding to
the given subject search record | ||
| Parameters | osid.type.Type | subjectSearchRecordType | a subject search record type |
| Return | osid.ontology.records.SubjectSearchResultsRecord | the subject search results 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. | |