Interface JobProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface JobProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
JobProcessorQueryInspector	getJobProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
JobProcessorList	getJobProcessors()	Gets the JobProcessorList resulting from a search.
JobProcessorSearchResultsRecord	getJobProcessorSearchResultsRecord(Type jobProcessorSearchRecordType)	Gets the job processor search results record corresponding to the given job 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

getJobProcessors

JobProcessorList getJobProcessors()

Gets the JobProcessorList resulting from a search.

Returns:

the job processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getJobProcessorQueryInspector

JobProcessorQueryInspector getJobProcessorQueryInspector()

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

Returns:

the job processor query inspector

Compliance:

mandatory - This method must be implemented.

getJobProcessorSearchResultsRecord

JobProcessorSearchResultsRecord getJobProcessorSearchResultsRecord(Type jobProcessorSearchRecordType)
                                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorSearchRecordType - a job processor search record type

Returns:

the job processor search results record

Throws:

NullArgumentException - jobProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(jobProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.