Interface ProcessProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProcessProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProcessProcessorQueryInspector	getProcessProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProcessProcessorList	getProcessProcessors()	Gets the process processor list resulting from a search.
ProcessProcessorSearchResultsRecord	getProcessProcessorSearchResultsRecord(Type processProcessorSearchRecordType)	Gets the process processor search results record corresponding to the given process processor 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

getProcessProcessors

ProcessProcessorList getProcessProcessors()

Gets the process processor list resulting from a search.

Returns:

the process processor list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProcessProcessorQueryInspector

ProcessProcessorQueryInspector getProcessProcessorQueryInspector()

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

Returns:

the process processor query inspector

Compliance:

mandatory - This method must be implemented.

getProcessProcessorSearchResultsRecord

ProcessProcessorSearchResultsRecord getProcessProcessorSearchResultsRecord(Type processProcessorSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

processProcessorSearchRecordType - a process processor search record type

Returns:

the process processor search results record

Throws:

NullArgumentException - processProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.