Interface PackageSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PackageSearch
extends OsidSearch

PackageSearch defines the interface for specifying package search options.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongPackages

void searchAmongPackages(IdList packageIds)

Execute this search among the given list of packages.

Parameters:

packageIds - list of packages

Throws:

NullArgumentException - packageIds is null

Compliance:

mandatory - This method must be implemented.

orderPackageResults

void orderPackageResults(PackageSearchOrder packageSearchOrder)

Specify an ordering to the search results.

Parameters:

packageSearchOrder - package search order

Throws:

NullArgumentException - packageSearchOrder is null

UnsupportedException - packageSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPackageSearchRecord

PackageSearchRecord getPackageSearchRecord(Type packageSearchRecordType)
                                    throws OperationFailedException

Gets the package search record corresponding to the given package search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

packageSearchRecordType - a package search record type

Returns:

the package search record

Throws:

NullArgumentException - packageSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(packageSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.