public interface CompositionEnablerSearch extends OsidSearch
The search interface for governing composition enabler searches.
Modifier and Type | Method and Description |
---|---|
CompositionEnablerSearchRecord |
getCompositionEnablerSearchRecord(Type compositionEnablerSearchRecordType)
Gets the composition enabler search record corresponding to the given
composition enabler search record
Type. |
void |
orderCompositionEnablerResults(CompositionEnablerSearchOrder compositionEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCompositionEnablers(IdList compositionEnablerIds)
Execute this search among the given list of composition enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCompositionEnablers(IdList compositionEnablerIds)
compositionEnablerIds
- list of composition enablersNullArgumentException
- compositionEnablerIds
is null
mandatory
- This method must be implemented. void orderCompositionEnablerResults(CompositionEnablerSearchOrder compositionEnablerSearchOrder)
compositionEnablerSearchOrder
- composition enabler search orderNullArgumentException
-
compositionEnablerSearchOrder
is null
UnsupportedException
-
compositionEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. CompositionEnablerSearchRecord getCompositionEnablerSearchRecord(Type compositionEnablerSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.compositionEnablerSearchRecordType
- a composition enabler
search record typeNullArgumentException
-
compositionEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(compositionEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.