public interface ValueEnablerSearch extends OsidSearch
The search interface for governing value enabler searches.
Modifier and Type | Method and Description |
---|---|
ValueEnablerSearchRecord |
getValueEnablerSearchRecord(Type valueEnablerSearchRecordType)
Gets the value enabler search record corresponding to the given value
enabler search record
Type. |
void |
orderValueEnablerResults(ValueEnablerSearchOrder valueEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongValueEnablers(IdList valueEnablerIds)
Execute this search among the given list of value enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongValueEnablers(IdList valueEnablerIds)
valueEnablerIds
- list of value enablersNullArgumentException
- valueEnablerIds
is null
mandatory
- This method must be implemented. void orderValueEnablerResults(ValueEnablerSearchOrder valueEnablerSearchOrder)
valueEnablerSearchOrder
- value enabler search orderNullArgumentException
- valueEnablerSearchOrder
is null
UnsupportedException
- valueEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. ValueEnablerSearchRecord getValueEnablerSearchRecord(Type valueEnablerSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.valueEnablerSearchRecordType
- a value enabler search record
typeNullArgumentException
-
valueEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(valueEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.