public interface RequisiteSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
RequisiteQueryInspector |
getRequisiteQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
RequisiteList |
getRequisites()
Gets the requisite list resulting from a search.
|
RequisiteSearchResultsRecord |
getRequisiteSearchResultsRecord(Type requisiteSearchRecordType)
Gets the requisite search results record corresponding to the given
requisite search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
RequisiteList getRequisites()
IllegalStateException
- the requisite list has already
been retrievedmandatory
- This method must be implemented. RequisiteQueryInspector getRequisiteQueryInspector()
mandatory
- This method must be implemented. RequisiteSearchResultsRecord getRequisiteSearchResultsRecord(Type requisiteSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.requisiteSearchRecordType
- a requisite search record typeNullArgumentException
-
requisiteSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requisiteSearchRecordType)
is
false
mandatory
- This method must be implemented.