Interface QueueSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface QueueSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
QueueQueryInspector	getQueueQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
QueueList	getQueues()	Gets the queue list resulting from a search.
QueueSearchResultsRecord	getQueueSearchResultsRecord(Type queueSearchRecordType)	Gets the queue search results record corresponding to the given queue 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

getQueues

QueueList getQueues()

Gets the queue list resulting from a search.

Returns:

the queue list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getQueueQueryInspector

QueueQueryInspector getQueueQueryInspector()

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

Returns:

the queue query inspector

Compliance:

mandatory - This method must be implemented.

getQueueSearchResultsRecord

QueueSearchResultsRecord getQueueSearchResultsRecord(Type queueSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

queueSearchRecordType - a queue search record type

Returns:

the queue search results record

Throws:

NullArgumentException - queueSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.