Interface ProgramEntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProgramEntryQuerySession

public interface ProgramEntrySearchSession
extends ProgramEntryQuerySession

This session provides methods for searching among ProgramEntries . The search query is constructed using the ProgramEntryQuery .

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

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include program entries 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

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

Method Summary

Modifier and Type	Method	Description
ProgramEntrySearchResults	getProgramEntriesBySearch(ProgramEntryQuery programEntryQuery, ProgramEntrySearch programEntrySearch)	Gets the search results matching the given search query using the given search.
ProgramEntryQuery	getProgramEntryQueryFromInspector(ProgramEntryQueryInspector programEntryQueryInspector)	Gets a program entry query from an inspector.
ProgramEntrySearch	getProgramEntrySearch()	Gets a program entry search.
ProgramEntrySearchOrder	getProgramEntrySearchOrder()	Gets a program entry 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 ProgramEntryQuerySession

canSearchProgramEntries, getCourseCatalog, getCourseCatalogId, getProgramEntriesByQuery, getProgramEntryQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchProgramEntries()	Tests if this user can perform ProgramEntry searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
ProgramEntryList	getProgramEntriesByQuery(ProgramEntryQuery programEntryQuery)	Gets a list of ProgramEntries matching the given program entry query.
ProgramEntryQuery	getProgramEntryQuery()	Gets a program entry query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

Method Details

getProgramEntrySearch

ProgramEntrySearch getProgramEntrySearch()

Gets a program entry search.

Returns:

the program entry search

Compliance:

mandatory - This method must be implemented.

getProgramEntrySearchOrder

ProgramEntrySearchOrder getProgramEntrySearchOrder()

Gets a program entry search order. The ProgramEntrySearchOrder is supplied to a ProgramEntrySearch to specify the ordering of results.

Returns:

the program entry search order

Compliance:

mandatory - This method must be implemented.

getProgramEntriesBySearch

ProgramEntrySearchResults getProgramEntriesBySearch(ProgramEntryQuery programEntryQuery,
 ProgramEntrySearch programEntrySearch)
                                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

programEntryQuery - the program entry query

programEntrySearch - the program entry search

Returns:

the program entry search results

Throws:

NullArgumentException - programEntryQuery or programEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - programEntryQuery or ProgramEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProgramEntryQueryFromInspector

ProgramEntryQuery getProgramEntryQueryFromInspector(ProgramEntryQueryInspector programEntryQueryInspector)

Gets a program entry query from an inspector. The inspector is available from a ProgramEntrySearchResults .

Parameters:

programEntryQueryInspector - a program entry query inspector

Returns:

the program entry query

Throws:

NullArgumentException - programEntryQueryInspector is null

UnsupportedException - programEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.