public interface PeriodSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
PeriodQueryInspector |
getPeriodQueryInspector()
Gets the inspector for the query to examine the periods used in the
search.
|
PeriodList |
getPeriods()
Gets the period list resulting from a search.
|
PeriodSearchResultsRecord |
getPeriodSearchResultsRecord(Type periodSearchRecordType)
Gets the period search results record corresponding to the given
period search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
PeriodList getPeriods()
IllegalStateException
- the period list has already
been retrievedmandatory
- This method must be implemented. PeriodQueryInspector getPeriodQueryInspector()
mandatory
- This method must be implemented. PeriodSearchResultsRecord getPeriodSearchResultsRecord(Type periodSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.periodSearchRecordType
- a period search record typeNullArgumentException
- periodSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(periodSearchRecordType)
is false
mandatory
- This method must be implemented.