Interface StepProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface StepProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
StepProcessorQueryInspector	getStepProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
StepProcessorList	getStepProcessors()	Gets the StepProcessorList resulting from a search.
StepProcessorSearchResultsRecord	getStepProcessorSearchResultsRecord(Type stepProcessorSearchRecordType)	Gets the step processor search results record corresponding to the given step 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

getStepProcessors

StepProcessorList getStepProcessors()

Gets the StepProcessorList resulting from a search.

Returns:

the step processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getStepProcessorQueryInspector

StepProcessorQueryInspector getStepProcessorQueryInspector()

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

Returns:

the step processor query inspector

Compliance:

mandatory - This method must be implemented.

getStepProcessorSearchResultsRecord

StepProcessorSearchResultsRecord getStepProcessorSearchResultsRecord(Type stepProcessorSearchRecordType)
                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

stepProcessorSearchRecordType - a step processor search record type

Returns:

the step processor search results record

Throws:

NullArgumentException - stepProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(stepProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.