org.osid.course

Interface TermQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

TermSearchSession

public interface TermQuerySession
extends OsidSession

This session provides methods for searching among Term objects. The search query is constructed using the TermQuery.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchTerms() Tests if this user can perform Term lookups.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
TermQuery	getTermQuery() Gets a term query.
TermList	getTermsByQuery(TermQuery termQuery) Gets a list of Terms matching the given term query.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.

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

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchTerms

boolean canSearchTerms()

Tests if this user can perform Term lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include terms in course catalog which are children of this course catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

getTermQuery

TermQuery getTermQuery()

Gets a term query.

Returns:

the term query

Compliance:

mandatory - This method must be implemented.

getTermsByQuery

TermList getTermsByQuery(TermQuery termQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Gets a list of Terms matching the given term query.

Parameters:

termQuery - the term query

Returns:

the returned TermList

Throws:

NullArgumentException - termQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - termQuery is not of this service

Compliance:

mandatory - This method must be implemented.