Interface PlanSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PlanSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PlanQueryInspector	getPlanQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
PlanList	getPlans()	Gets the plan list resulting from a search.
PlanSearchResultsRecord	getPlanSearchResultsRecord(Type planSearchRecordType)	Gets the plan search results record corresponding to the given plan 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

getPlans

PlanList getPlans()

Gets the plan list resulting from a search.

Returns:

the plan list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPlanQueryInspector

PlanQueryInspector getPlanQueryInspector()

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

Returns:

the plan query inspector

Compliance:

mandatory - This method must be implemented.

getPlanSearchResultsRecord

PlanSearchResultsRecord getPlanSearchResultsRecord(Type planSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

planSearchRecordType - a plan search record type

Returns:

the plan search record

Throws:

NullArgumentException - planSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(planSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.