Interface ModuleSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ModuleSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ModuleQueryInspector	getModuleQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
ModuleList	getModules()	Gets the module list resulting from a search.
ModuleSearchResultsRecord	getModuleSearchResultsRecord(Type moduleSearchRecordType)	Gets the module search results record corresponding to the given module 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

getModules

ModuleList getModules()

Gets the module list resulting from a search.

Returns:

the module list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getModuleQueryInspector

ModuleQueryInspector getModuleQueryInspector()

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

Returns:

the module query inspector

Compliance:

mandatory - This method must be implemented.

getModuleSearchResultsRecord

ModuleSearchResultsRecord getModuleSearchResultsRecord(Type moduleSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

moduleSearchRecordType - a module search record type

Returns:

the module search record

Throws:

NullArgumentException - moduleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(moduleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.