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

Modifier and Type	Method	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 .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

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.