org.osid.rules.check

Interface InstructionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface InstructionSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
InstructionQueryInspector	getInstructionQueryInspector() Gets the inspector for the query to examine the terms used in the search.
InstructionList	getInstructions() Gets the instruction list resulting from a search.
InstructionSearchResultsRecord	getInstructionSearchResultsRecord(Type instructionSearchRecordType) Gets the instruction search results record corresponding to the given instruction search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getInstructions

InstructionList getInstructions()

Gets the instruction list resulting from a search.

Returns:

the instruction list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getInstructionQueryInspector

InstructionQueryInspector getInstructionQueryInspector()

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

Returns:

the instruction query inspector

Compliance:

mandatory - This method must be implemented.

getInstructionSearchResultsRecord

InstructionSearchResultsRecord getInstructionSearchResultsRecord(Type instructionSearchRecordType)
                                                                 throws OperationFailedException,
                                                                        PermissionDeniedException

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

Parameters:

instructionSearchRecordType - an instruction search record type

Returns:

the instruction search results record

Throws:

NullArgumentException - instructionSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(instructionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.