Interface HoldEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface HoldEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
HoldEnablerQueryInspector	getHoldEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
HoldEnablerList	getHoldEnablers()	Gets the HoldEnablerList resulting from a search.
HoldEnablerSearchResultsRecord	getHoldEnablerSearchResultsRecord(Type holdEnablerSearchRecordType)	Gets the hold enabler search results record corresponding to the given hold enabler search record Type .This method must be 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

getHoldEnablers

HoldEnablerList getHoldEnablers()

Gets the HoldEnablerList resulting from a search.

Returns:

the hold enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getHoldEnablerQueryInspector

HoldEnablerQueryInspector getHoldEnablerQueryInspector()

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

Returns:

the hold enabler query inspector

Compliance:

mandatory - This method must be implemented.

getHoldEnablerSearchResultsRecord

HoldEnablerSearchResultsRecord getHoldEnablerSearchResultsRecord(Type holdEnablerSearchRecordType)
                                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

holdEnablerSearchRecordType - a hold enabler search record type

Returns:

the hold enabler search results record

Throws:

NullArgumentException - holdEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(holdEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.