Interface StepEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface StepEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
StepEnablerQueryInspector	getStepEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
StepEnablerList	getStepEnablers()	Gets the step enabler list resulting from a search.
StepEnablerSearchResultsRecord	getStepEnablerSearchResultsRecord(Type stepEnablerSearchRecordType)	Gets the step enabler search results record corresponding to the given step enabler 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

getStepEnablers

StepEnablerList getStepEnablers()

Gets the step enabler list resulting from a search.

Returns:

the step enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getStepEnablerQueryInspector

StepEnablerQueryInspector getStepEnablerQueryInspector()

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

Returns:

the step enabler query inspector

Compliance:

mandatory - This method must be implemented.

getStepEnablerSearchResultsRecord

StepEnablerSearchResultsRecord getStepEnablerSearchResultsRecord(Type stepEnablerSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

stepEnablerSearchRecordType - a step enabler search record type

Returns:

the step enabler search results record

Throws:

NullArgumentException - stepEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.