public interface AgendaSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
AgendaQueryInspector |
getAgendaQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
AgendaList |
getAgendas()
Gets the agenda list resulting from a search.
|
AgendaSearchResultsRecord |
getAgendaSearchResultsRecord(Type agendaSearchRecordType)
Gets the agenda search results record corresponding to the given
agenda search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
AgendaList getAgendas()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. AgendaQueryInspector getAgendaQueryInspector()
mandatory
- This method must be implemented. AgendaSearchResultsRecord getAgendaSearchResultsRecord(Type agendaSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to
retrieve an object implementing the requested record.agendaSearchRecordType
- an agenda search record typeNullArgumentException
- agendaSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(agendaSearchRecordType)
is false
mandatory
- This method must be implemented.