public interface InstallationSearch extends OsidSearch
InstallationSearch
defines the interface for specifying
installation search options.
Modifier and Type | Method and Description |
---|---|
InstallationSearchRecord |
getInstallationSearchRecord(Type installationSearchRecordType)
Gets the installation search record corresponding to the given
installation search record
Type. |
void |
orderInstallationResults(InstallationSearchOrder installationSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongInstallations(IdList installationIds)
Execute this search among the given list of installations.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongInstallations(IdList installationIds)
installationIds
- list of installationsNullArgumentException
- installationIds
is null
mandatory
- This method must be implemented. void orderInstallationResults(InstallationSearchOrder installationSearchOrder)
installationSearchOrder
- installation search orderNullArgumentException
- installationSearchOrder
is null
UnsupportedException
- installationSearchOrder
is not of this servicemandatory
- This method must be implemented. InstallationSearchRecord getInstallationSearchRecord(Type installationSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.installationSearchRecordType
- an installation search record
typeNullArgumentException
-
installationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(installationSearchRecordType)
is
false
mandatory
- This method must be implemented.