org.osid.course.program

Interface ProgramSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.course.program.ProgramQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.