public interface DispatchSearch extends OsidSearch
The search interface for governing dispatch searches.
Modifier and Type | Method and Description |
---|---|
DispatchSearchRecord |
getDispatchSearchRecord(Type dispatchSearchRecordType)
Gets the dis[atch search record corresponding to the given dispatch
search record
Type. |
void |
orderDispatchResults(DispatchSearchOrder dispatchSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongDispatches(IdList dispatchIds)
Execute this search among the given list of dispatches.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongDispatches(IdList dispatchIds)
dispatchIds
- list of dispatchesNullArgumentException
- dispatchIds
is
null
mandatory
- This method must be implemented. void orderDispatchResults(DispatchSearchOrder dispatchSearchOrder)
dispatchSearchOrder
- dispatch search orderNullArgumentException
- dispatchSearchOrder
is null
UnsupportedException
- dispatchSearchOrder
is not of this servicemandatory
- This method must be implemented. DispatchSearchRecord getDispatchSearchRecord(Type dispatchSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.dispatchSearchRecordType
- a dispatch search record typeNullArgumentException
- dispatchSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(dispatchSearchRecordType)
is
false
mandatory
- This method must be implemented.