Interface HoldSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface HoldSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getHolds

HoldList getHolds()

Gets the hold list resulting from a search.

Returns:

the hold list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getHoldQueryInspector

HoldQueryInspector getHoldQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the hold query inspector

Compliance:

mandatory - This method must be implemented.

getHoldSearchResultsRecord

HoldSearchResultsRecord getHoldSearchResultsRecord(Type holdSearchRecordType)
                                            throws OperationFailedException,
PermissionDeniedException

Gets the hold search results record corresponding to the given hold search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

holdSearchRecordType - a hold search record type

Returns:

the hold search results record

Throws:

NullArgumentException - holdSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(holdSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.