Interface AvailabilityEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AvailabilityEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AvailabilityEnablerQueryInspector	getAvailabilityEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AvailabilityEnablerList	getAvailabilityEnablers()	Gets the AvailabilityEnablerList resulting from a search.
AvailabilityEnablerSearchResultsRecord	getAvailabilityEnablerSearchResultsRecord(Type availabilityEnablerSearchRecordType)	Gets the availability enabler search results record corresponding to the given availability enabler search record Type.

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

getAvailabilityEnablers

AvailabilityEnablerList getAvailabilityEnablers()

Gets the AvailabilityEnablerList resulting from a search.

Returns:

the availability enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerQueryInspector

AvailabilityEnablerQueryInspector getAvailabilityEnablerQueryInspector()

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

Returns:

the availability enabler query inspector

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerSearchResultsRecord

AvailabilityEnablerSearchResultsRecord getAvailabilityEnablerSearchResultsRecord(Type availabilityEnablerSearchRecordType)
                                                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

availabilityEnablerSearchRecordType - an availability enabler search record type

Returns:

the availability enabler search results record

Throws:

NullArgumentException - availabilityEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(availabilityEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.