public interface CyclicEventSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
CyclicEventQueryInspector |
getCyclicEventQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
CyclicEventList |
getCyclicEvents()
Gets the cyclic event list resulting from the search.
|
CyclicEventSearchResultsRecord |
getCyclicEventSearchResultsRecord(Type cyclicEventSearchRecordType)
Gets the cyclic event search results record corresponding to the given
event search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CyclicEventList getCyclicEvents()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. CyclicEventQueryInspector getCyclicEventQueryInspector()
mandatory
- This method must be implemented. CyclicEventSearchResultsRecord getCyclicEventSearchResultsRecord(Type cyclicEventSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.cyclicEventSearchRecordType
- a cyclic event search record typeNullArgumentException
-
cyclicEventSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cyclicEventSearchRecordType)
is
false
mandatory
- This method must be implemented.