public interface SubjectSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
SubjectQueryInspector |
getSubjectQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
SubjectList |
getSubjects()
Gets the subject list resulting from the search.
|
SubjectSearchResultsRecord |
getSubjectSearchResultsRecord(Type subjectSearchRecordType)
Gets the subject search results record corresponding to the given
subject search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
SubjectList getSubjects()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. SubjectQueryInspector getSubjectQueryInspector()
mandatory
- This method must be implemented. SubjectSearchResultsRecord getSubjectSearchResultsRecord(Type subjectSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.subjectSearchRecordType
- a subject search record typeNullArgumentException
- subjectSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(subjectSearchRecordType)
is false
mandatory
- This method must be implemented.