public interface AgendaSearch extends OsidSearch
The search interface for governing agenda searches.
Modifier and Type | Method and Description |
---|---|
AgendaSearchRecord |
getAgendaSearchRecord(Type agendaSearchRecordType)
Gets the agenda search record corresponding to the given agenda search
record
Type. |
void |
orderAgendaResults(AgendaSearchOrder agendaSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongAgendas(IdList agendaIds)
Execute this search among the given list of agendas.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAgendas(IdList agendaIds)
agendaIds
- list of agendasNullArgumentException
- agendaIds
is
null
mandatory
- This method must be implemented. void orderAgendaResults(AgendaSearchOrder agendaSearchOrder)
agendaSearchOrder
- agenda search orderNullArgumentException
- agendaSearchOrder
is null
UnsupportedException
- agendaSearchOrder
is not of this servicemandatory
- This method must be implemented. AgendaSearchRecord getAgendaSearchRecord(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.