public interface ValueSearch extends OsidSearch
The interface for governing value searches.
Modifier and Type | Method and Description |
---|---|
ValueSearchRecord |
getValueSearchRecord(Type valueSearchRecordType)
Gets the value search record corresponding to the given value search
record
Type. |
void |
orderValueResults(ValueSearchOrder valueSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongValues(IdList valueIds)
Executes this search among a given list of values.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongValues(IdList valueIds)
valueIds
- list of valuesNullArgumentException
- valueIds
is
null
mandatory
- This method must be implemented. void orderValueResults(ValueSearchOrder valueSearchOrder)
valueSearchOrder
- value search orderNullArgumentException
- valueSearchOrder
is null
UnsupportedException
- valueSearchOrder
is not of this servicemandatory
- This method must be implemented. ValueSearchRecord getValueSearchRecord(Type valueSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.valueSearchRecordType
- a value search record typeNullArgumentException
- valueSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(valueSearchRecordType)
is false
mandatory
- This method must be implemented.