Interface StepConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface StepConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
StepConstrainerQueryInspector	getStepConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
StepConstrainerList	getStepConstrainers()	Gets the StepConstrainerList resulting from a search.
StepConstrainerSearchResultsRecord	getStepConstrainerSearchResultsRecord(Type stepConstrainerSearchRecordType)	Gets the step constrainer search results record corresponding to the given step constrainer 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

getStepConstrainers

StepConstrainerList getStepConstrainers()

Gets the StepConstrainerList resulting from a search.

Returns:

the step constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getStepConstrainerQueryInspector

StepConstrainerQueryInspector getStepConstrainerQueryInspector()

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

Returns:

the step constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getStepConstrainerSearchResultsRecord

StepConstrainerSearchResultsRecord getStepConstrainerSearchResultsRecord(Type stepConstrainerSearchRecordType)
                                                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

stepConstrainerSearchRecordType - a step constrainer search record type

Returns:

the step constrainer search results record

Throws:

NullArgumentException - stepConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(stepConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.