public interface ParameterSearch extends OsidSearch
ParameterSearch
specifies the interface for specifying
parameter search options.
Modifier and Type | Method and Description |
---|---|
ParameterSearchRecord |
getParameterSearchRecord(Type parameterSearchRecordType)
Gets the parameter search record corresponding to the given parameter
search record
Type. |
void |
orderParameterResults(ParameterSearchOrder parameterSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongParameters(IdList parameterIds)
Executes this search among a given list of parameters.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongParameters(IdList parameterIds)
parameterIds
- list of parametersNullArgumentException
- parameterIds
is
null
mandatory
- This method must be implemented. void orderParameterResults(ParameterSearchOrder parameterSearchOrder)
parameterSearchOrder
- parameter search orderNullArgumentException
- parameterSearchOrder
is null
UnsupportedException
- parameterSearchOrder
is not of this servicemandatory
- This method must be implemented. ParameterSearchRecord getParameterSearchRecord(Type parameterSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.parameterSearchRecordType
- a parameter search record typeNullArgumentException
- parameterRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(parameterSearchRecordType)
is
false
mandatory
- This method must be implemented.