public interface PackageSearch extends OsidSearch
PackageSearch
defines the interface for specifying
package search options.
Modifier and Type | Method and Description |
---|---|
PackageSearchRecord |
getPackageSearchRecord(Type packageSearchRecordType)
Gets the package search record corresponding to the given package
search record
Type. |
void |
orderPackageResults(PackageSearchOrder packageSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongPackages(IdList packageIds)
Execute this search among the given list of packages.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongPackages(IdList packageIds)
packageIds
- list of packagesNullArgumentException
- packageIds
is
null
mandatory
- This method must be implemented. void orderPackageResults(PackageSearchOrder packageSearchOrder)
packageSearchOrder
- package search orderNullArgumentException
- packageSearchOrder
is null
UnsupportedException
- packageSearchOrder
is not of this servicemandatory
- This method must be implemented. PackageSearchRecord getPackageSearchRecord(Type packageSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.packageSearchRecordType
- a package search record typeNullArgumentException
- packageSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(packageSearchRecordType)
is false
mandatory
- This method must be implemented.