Interface ProcedureSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProcedureSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProcedureQueryInspector	getProcedureQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
ProcedureList	getProcedures()	Gets the procedure list resulting from a search.
ProcedureSearchResultsRecord	getProcedureSearchResultsRecord(Type procedureSearchRecordType)	Gets the procedure search results record corresponding to the given procedure 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

getProcedures

ProcedureList getProcedures()

Gets the procedure list resulting from a search.

Returns:

the procedure list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getProcedureQueryInspector

ProcedureQueryInspector getProcedureQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getProcedureSearchResultsRecord

ProcedureSearchResultsRecord getProcedureSearchResultsRecord(Type procedureSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

procedureSearchRecordType - a procedure search record type

Returns:

the procedure search record

Throws:

NullArgumentException - procedureSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(procedureSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.