public interface EventSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
EventQueryInspector |
getEventQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
EventList |
getEvents()
Gets the event list resulting from the search.
|
EventSearchResultsRecord |
getEventSearchResultsRecord(Type eventSearchRecordType)
Gets the event search results record corresponding to the given event
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
EventList getEvents()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. EventQueryInspector getEventQueryInspector()
mandatory
- This method must be implemented. EventSearchResultsRecord getEventSearchResultsRecord(Type eventSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.eventSearchRecordType
- an event search record typeNullArgumentException
- eventSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(eventSearchRecordType)
is false
mandatory
- This method must be implemented.