public interface SignalEnablerSearch extends OsidSearch
The search interface for governing signal enabler searches.
Modifier and Type | Method and Description |
---|---|
SignalEnablerSearchRecord |
getSignalEnablerSearchRecord(Type signalEnablerSearchRecordType)
Gets the signal enabler search record corresponding to the given
signal enabler search record
Type. |
void |
orderSignalEnablerResults(SignalEnablerSearchOrder signalEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongSignalEnablers(IdList mapIds)
Execute this search among the given list of signal enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSignalEnablers(IdList mapIds)
mapIds
- list of signal enablersNullArgumentException
- mapIds
is
null
mandatory
- This method must be implemented. void orderSignalEnablerResults(SignalEnablerSearchOrder signalEnablerSearchOrder)
signalEnablerSearchOrder
- signal enabler search orderNullArgumentException
- signalEnablerSearchOrder
is null
UnsupportedException
- signalEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. SignalEnablerSearchRecord getSignalEnablerSearchRecord(Type signalEnablerSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.signalEnablerSearchRecordType
- a signal enabler search record
typeNullArgumentException
-
signalEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(signalEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.