public interface CanonicalUnitSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitQueryInspector |
getCanonicalUnitQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
CanonicalUnitList |
getCanonicalUnits()
Gets the canonical unit list resulting from a search.
|
CanonicalUnitSearchResultsRecord |
getCanonicalUnitSearchResultsRecord(Type canonicalUnitSearchRecordType)
Gets the record corresponding to the given canonical unit search
record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CanonicalUnitList getCanonicalUnits()
IllegalStateException
- the list has already been
retrievedmandatory
- This method must be implemented. CanonicalUnitQueryInspector getCanonicalUnitQueryInspector()
mandatory
- This method must be implemented. CanonicalUnitSearchResultsRecord getCanonicalUnitSearchResultsRecord(Type canonicalUnitSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.canonicalUnitSearchRecordType
- a canonical unit search record
typeNullArgumentException
-
canonicalUnitSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitSearchRecordType)
is
false
mandatory
- This method must be implemented.