Interface PackageSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PackageSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
PackageQueryInspector	getPackageQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PackageList	getPackages()	Gets the package list resulting from the search.
PackageSearchResultsRecord	getPackageSearchResultsRecord(Type packageSearchRecordType)	Gets the package search results record corresponding to the given package search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getPackages

PackageList getPackages()

Gets the package list resulting from the search.

Returns:

the package list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getPackageQueryInspector

PackageQueryInspector getPackageQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the package query inspector

Compliance:

mandatory - This method must be implemented.

getPackageSearchResultsRecord

PackageSearchResultsRecord getPackageSearchResultsRecord(Type packageSearchRecordType)
                                                  throws OperationFailedException

Gets the package search results 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 results record

Throws:

NullArgumentException - packageSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(packageSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.