Interface QueueEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface QueueEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
QueueEnablerQueryInspector	getQueueEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
QueueEnablerList	getQueueEnablers()	Gets the queue enabler list resulting from a search.
QueueEnablerSearchResultsRecord	getQueueEnablerSearchResultsRecord(Type queueEnablerSearchRecordType)	Gets the queue enabler search results record corresponding to the given queue enabler 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

getQueueEnablers

QueueEnablerList getQueueEnablers()

Gets the queue enabler list resulting from a search.

Returns:

the queue enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getQueueEnablerQueryInspector

QueueEnablerQueryInspector getQueueEnablerQueryInspector()

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

Returns:

the queue enabler query inspector

Compliance:

mandatory - This method must be implemented.

getQueueEnablerSearchResultsRecord

QueueEnablerSearchResultsRecord getQueueEnablerSearchResultsRecord(Type queueEnablerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

queueEnablerSearchRecordType - a queue enabler search record type

Returns:

the queue enabler search results record

Throws:

NullArgumentException - queueEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.