Interface InstallationPackageSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface InstallationPackageSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
InstallationPackageQueryInspector	getInstallationPackageQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
InstallationPackageList	getInstallationPackages()	Gets the package list resulting from the search.
InstallationPackageSearchResultsRecord	getInstallationPackageSearchResultsRecord(Type installationPackageSearchRecordType)	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

getInstallationPackages

InstallationPackageList getInstallationPackages()

Gets the package list resulting from the search.

Returns:

the package list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getInstallationPackageQueryInspector

InstallationPackageQueryInspector getInstallationPackageQueryInspector()

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.

getInstallationPackageSearchResultsRecord

InstallationPackageSearchResultsRecord getInstallationPackageSearchResultsRecord(Type installationPackageSearchRecordType)
                                                                          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:

installationPackageSearchRecordType - a package search record type

Returns:

the package search results record

Throws:

NullArgumentException - installationPackageSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(packageSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.