Interface ProgramSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProgramQuerySession

public interface ProgramSearchSession
extends ProgramQuerySession

This session provides methods for searching among Programs . The search query is constructed using the ProgramQuery .

getProgramsByQuery() is the basic search method and returns a list of Programs . A more advanced search may be performed with getProgramsBySearch() .It accepts a ProgramSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProgramsBySearch() returns a ProgramSearchResults that can be used to access the resulting ProgramList or be used to perform a search within the result set through ProgramSearch .

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include programs in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
• isolated course catalog view: searches are restricted to courses in this course catalog

Programs may have a query record indicated by their respective record types. The query record is accessed via the ProgramQuery .

Method Summary

Modifier and Type	Method	Description
ProgramQuery	getProgramQueryFromInspector(ProgramQueryInspector programQueryInspector)	Gets a program query from an inspector.
ProgramSearchResults	getProgramsBySearch(ProgramQuery programQuery, ProgramSearch programSearch)	Gets the search results matching the given search query using the given search.
ProgramSearch	getProgramSearch()	Gets a program search.
ProgramSearchOrder	getProgramSearchOrder()	Gets a program 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 ProgramQuerySession

canSearchPrograms, getCourseCatalog, getCourseCatalogId, getProgramQuery, getProgramsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchPrograms()	Tests if this user can perform Program searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
ProgramQuery	getProgramQuery()	Gets a program query.
ProgramList	getProgramsByQuery(ProgramQuery programQuery)	Gets a list of Programs matching the given program query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

Method Details

getProgramSearch

ProgramSearch getProgramSearch()

Gets a program search.

Returns:

the program search

Compliance:

mandatory - This method must be implemented.

getProgramSearchOrder

ProgramSearchOrder getProgramSearchOrder()

Gets a program search order. The ProgramSearchOrder is supplied to a ProgramSearch to specify the ordering of results.

Returns:

the program search order

Compliance:

mandatory - This method must be implemented.

getProgramsBySearch

ProgramSearchResults getProgramsBySearch(ProgramQuery programQuery,
 ProgramSearch programSearch)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

programQuery - the program query

programSearch - the program search

Returns:

the program search results

Throws:

NullArgumentException - programQuery or programSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - programQuery or programSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProgramQueryFromInspector

ProgramQuery getProgramQueryFromInspector(ProgramQueryInspector programQueryInspector)

Gets a program query from an inspector. The inspector is available from a ProgramSearchResults .

Parameters:

programQueryInspector - a program query inspector

Returns:

the program query

Throws:

NullArgumentException - programQueryInspector is null

UnsupportedException - programQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.