public interface ConfigurationSearch extends OsidSearch
The search interface to query a configuration.
Modifier and Type | Method and Description |
---|---|
ConfigurationSearchRecord |
getConfigurationSearchRecord(Type configurationSearchRecordType)
Gets the configuration search record corresponding to the given
configuration search record
Type. |
void |
orderConfigurationResults(ConfigurationSearchOrder configurationSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongConfigurations(IdList configurationIds)
Execute this search among the given list of configurations.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongConfigurations(IdList configurationIds)
configurationIds
- list of configurationsNullArgumentException
- configurationIds
is null
mandatory
- This method must be implemented. void orderConfigurationResults(ConfigurationSearchOrder configurationSearchOrder)
configurationSearchOrder
- configuration search orderNullArgumentException
- configurationSearchOrder
is null
UnsupportedException
- configurationSearchOrder
is not of this servicemandatory
- This method must be implemented. ConfigurationSearchRecord getConfigurationSearchRecord(Type configurationSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.configurationSearchRecordType
- a configuration search record
typeNullArgumentException
-
configurationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(configurationSearchRecordType)
is
false
mandatory
- This method must be implemented.