Interface QueueConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface QueueConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
QueueConstrainerQueryInspector	getQueueConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
QueueConstrainerList	getQueueConstrainers()	Gets the QueueConstrainerList resulting from a search.
QueueConstrainerSearchResultsRecord	getQueueConstrainerSearchResultsRecord(Type queueConstrainerSearchRecordType)	Gets the queue constrainer search results record corresponding to the given queue constrainer 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

getQueueConstrainers

QueueConstrainerList getQueueConstrainers()

Gets the QueueConstrainerList resulting from a search.

Returns:

the queue constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerQueryInspector

QueueConstrainerQueryInspector getQueueConstrainerQueryInspector()

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

Returns:

the queue constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerSearchResultsRecord

QueueConstrainerSearchResultsRecord getQueueConstrainerSearchResultsRecord(Type queueConstrainerSearchRecordType)
                                                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

queueConstrainerSearchRecordType - a queue constrainer search record type

Returns:

the queue constrainer search results record

Throws:

NullArgumentException - queueConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(queueConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.