public interface ConvocationSearch extends OsidSearch
The search interface for governing convocation searches.
Modifier and Type | Method and Description |
---|---|
ConvocationSearchRecord |
getConvocationSearchRecord(Type convocationSearchRecordType)
Gets the convocation search record corresponding to the given
convocation search record
Type. |
void |
orderConvocationResults(ConvocationSearchOrder convocationSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongConvocations(IdList convocationIds)
Execute this search among the given list of convocations.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongConvocations(IdList convocationIds)
convocationIds
- list of convocationsNullArgumentException
- convocationIds
is null
mandatory
- This method must be implemented. void orderConvocationResults(ConvocationSearchOrder convocationSearchOrder)
convocationSearchOrder
- convocation search orderNullArgumentException
- convocationSearchOrder
is null
UnsupportedException
- convocationSearchOrder
is not of this servicemandatory
- This method must be implemented. ConvocationSearchRecord getConvocationSearchRecord(Type convocationSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.convocationSearchRecordType
- a convocation search record typeNullArgumentException
-
convocationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(convocationSearchRecordType)
is
false
mandatory
- This method must be implemented.