Interface StepSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface StepSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
StepQueryInspector	getStepQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
StepList	getSteps()	Gets the step list resulting from a search.
StepSearchResultsRecord	getStepSearchResultsRecord(Type stepSearchRecordType)	Gets the step search results record corresponding to the given step search record Type .This method is 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

getSteps

StepList getSteps()

Gets the step list resulting from a search.

Returns:

the step list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getStepQueryInspector

StepQueryInspector getStepQueryInspector()

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

Returns:

the step query inspector

Compliance:

mandatory - This method must be implemented.

getStepSearchResultsRecord

StepSearchResultsRecord getStepSearchResultsRecord(Type stepSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

stepSearchRecordType - a step search record type

Returns:

the step search results record

Throws:

NullArgumentException - stepSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.