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