Interface QueueProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface QueueProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
QueueProcessorQueryInspector	getQueueProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
QueueProcessorList	getQueueProcessors()	Gets the QueueProcessorList resulting from a search.
QueueProcessorSearchResultsRecord	getQueueProcessorSearchResultsRecord(Type queueProcessorSearchRecordType)	Gets the queue processor search results record corresponding to the given queue processor search record Type .This method must be 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

getQueueProcessors

QueueProcessorList getQueueProcessors()

Gets the QueueProcessorList resulting from a search.

Returns:

the queue processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getQueueProcessorQueryInspector

QueueProcessorQueryInspector getQueueProcessorQueryInspector()

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

Returns:

the queue processor query inspector

Compliance:

mandatory - This method must be implemented.

getQueueProcessorSearchResultsRecord

QueueProcessorSearchResultsRecord getQueueProcessorSearchResultsRecord(Type queueProcessorSearchRecordType)
                                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

queueProcessorSearchRecordType - a queue processor search record type

Returns:

the queue processor search results record

Throws:

NullArgumentException - queueProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(queueProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.