public interface ActivityUnitSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ActivityUnitQueryInspector |
getActivityUnitQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ActivityUnitList |
getActivityUnits()
Gets the activity unit list resulting from a search.
|
ActivityUnitSearchResultsRecord |
getActivityUnitSearchResultsRecord(Type activityUnitSearchRecordType)
Gets the activity unit search results record corresponding to the
given activity unit search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ActivityUnitList getActivityUnits()
IllegalStateException
- the activity unit list has
already been retrievedmandatory
- This method must be implemented. ActivityUnitQueryInspector getActivityUnitQueryInspector()
mandatory
- This method must be implemented. ActivityUnitSearchResultsRecord getActivityUnitSearchResultsRecord(Type activityUnitSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.activityUnitSearchRecordType
- a activity unit search record
typeNullArgumentException
-
activityUnitSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityUnitSearchRecordType)
is
false
mandatory
- This method must be implemented.