org.osid.hold.rules

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

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.