Interface PlanSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PlanQuerySession

public interface PlanSearchSession
extends PlanQuerySession

This session provides methods for searching Plans. The search query is constructed using the PlanQuery. The plan record Type also specifies the record for the plan query.

getPlansByQuery() is the basic search method and returns a list of CourseCatalog elements. A more advanced search may be performed with getPlansBySearch(). It accepts a PlanSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPlansBySearch() returns a PlanSearchResults that can be used to access the resulting PlanList or be used to perform a search within the result set through PlanSearch.

Plans may have a query record indicated by their respective record types. The query record is accessed via the PlanQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
PlanQuery	getPlanQueryFromInspector(PlanQueryInspector planQueryInspector)	Gets a plan query from an inspector.
PlanSearchResults	getPlansBySearch(PlanQuery planQuery, PlanSearch planSearch)	Gets the search results matching the given search.
PlanSearch	getPlanSearch()	Gets a plan search.
PlanSearchOrder	getPlanSearchOrder()	Gets a plan search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface PlanQuerySession

canSearchPlans, getCourseCatalog, getCourseCatalogId, getPlanQuery, getPlansByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchPlans()	Tests if this user can perform susbcription searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
PlanQuery	getPlanQuery()	Gets a plan query.
PlanList	getPlansByQuery(PlanQuery planQuery)	Gets a list of plans matching the given plan query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

Method Details

getPlanSearch

PlanSearch getPlanSearch()

Gets a plan search.

Returns:

the plan search

Compliance:

mandatory - This method must be implemented.

getPlanSearchOrder

PlanSearchOrder getPlanSearchOrder()

Gets a plan search order. The PlanSearchOrder is supplied to a PlanSearch to specify the ordering of results.

Returns:

the plan search order interface

Compliance:

mandatory - This method must be implemented.

getPlansBySearch

PlanSearchResults getPlansBySearch(PlanQuery planQuery,
 PlanSearch planSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

planQuery - the plan query

planSearch - the plan search

Returns:

the plan search results

Throws:

NullArgumentException - planQuery or planSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - planQuery or planSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPlanQueryFromInspector

PlanQuery getPlanQueryFromInspector(PlanQueryInspector planQueryInspector)

Gets a plan query from an inspector. The inspector is available from an PlanSearchResults.

Parameters:

planQueryInspector - a plan query inspector

Returns:

the plan query

Throws:

NullArgumentException - planQueryInspector is null

UnsupportedException - planQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.