public interface HoldSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
HoldQueryInspector |
getHoldQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
HoldList |
getHolds()
Gets the hold list resulting from a search.
|
HoldSearchResultsRecord |
getHoldSearchResultsRecord(Type holdSearchRecordType)
Gets the hold search results record corresponding to the given hold
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
HoldList getHolds()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. HoldQueryInspector getHoldQueryInspector()
mandatory
- This method must be implemented. HoldSearchResultsRecord getHoldSearchResultsRecord(Type holdSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an
object implementing the requested record.holdSearchRecordType
- a hold search record typeNullArgumentException
- holdSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(holdSearchRecordType)
is false
mandatory
- This method must be implemented.