public interface TimePeriodSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
TimePeriodQueryInspector |
getTimePeriodQueryInspector()
Gets the inspector for the query to examine the time periods used in
the search.
|
TimePeriodList |
getTimePeriods()
Gets the time period list resulting from the search.
|
TimePeriodSearchResultsRecord |
getTimePeriodSearchResultsRecord(Type timePeriodSearchRecordType)
Gets the time period search results record corresponding to the given
time period search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
TimePeriodList getTimePeriods()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. TimePeriodQueryInspector getTimePeriodQueryInspector()
mandatory
- This method must be implemented. TimePeriodSearchResultsRecord getTimePeriodSearchResultsRecord(Type timePeriodSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.timePeriodSearchRecordType
- a time period search record typeNullArgumentException
-
timePeriodSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(timePeriodSearchRecordType)
is
false
mandatory
- This method must be implemented.