public interface ModuleSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and 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. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ModuleList getModules()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. ModuleQueryInspector getModuleQueryInspector()
mandatory
- This method must be implemented. ModuleSearchResultsRecord getModuleSearchResultsRecord(Type moduleSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.moduleSearchRecordType
- a module search record typeNullArgumentException
- moduleSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(moduleSearchRecordType)
is false
mandatory
- This method must be implemented.