Interface ActivityUnitSearchSession

All Superinterfaces:

ActivityUnitQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActivityUnitSearchSession
extends ActivityUnitQuerySession

This session provides methods for searching among ActivityUnits . The search query is constructed using the ActivityUnitQuery .

getActivityUnitsByQuery() is the basic search method and returns a list of ActivityUnits . A more advanced search may be performed with getActivityUnitsBySearch() .It accepts an ActivityUnitSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getActivityUnitsBySearch() returns an ActivityUnitSearchResults that can be used to access the resulting ActivityUnitList or be used to perform a search within the result set through ActivityUnitSearch .

This session defines views that offer differing behaviors for searching.

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

Activity Units may have a query record indicated by their respective record types. The query record is accessed via the ActivityUnitQuery .

Method Summary

Modifier and Type	Method	Description
ActivityUnitQuery	getActivityUnitQueryFromInspector(ItemQueryInspector activityUnitQueryInspector)	Gets an activity unit query from an inspector.
ActivityUnitSearchResults	getActivityUnitsBySearch(ActivityUnitQuery activityUnitQuery, ActivityUnitSearch activityUnitSearch)	Gets the search results matching the given search query using the given search.
ActivityUnitSearch	getActivityUnitSearch()	Gets an activity unit search.
ActivityUnitSearchOrder	getActivityUnitSearchOrder()	Gets an activity search order.

Methods inherited from interface ActivityUnitQuerySession

canSearchActivityUnits, getActivityUnitQuery, getActivityUnitsByQuery, getCourseCatalog, getCourseCatalogId, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchActivityUnits()	Tests if this user can perform ActivityUnit lookups.
ActivityUnitQuery	getActivityUnitQuery()	Gets an activity unit query.
ActivityUnitList	getActivityUnitsByQuery(ActivityUnitQuery activityUnitQuery)	Gets a list of ActivityUnits matching the given activity unit query.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

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.

Method Details

getActivityUnitSearch

ActivityUnitSearch getActivityUnitSearch()

Gets an activity unit search.

Returns:

the activity unit search

Compliance:

mandatory - This method must be implemented.

getActivityUnitSearchOrder

ActivityUnitSearchOrder getActivityUnitSearchOrder()

Gets an activity search order. The ActivityUnitSearchOrder is supplied to an ActivityUnitSearch to specify the ordering of results.

Returns:

the activity unit search order

Compliance:

mandatory - This method must be implemented.

getActivityUnitsBySearch

ActivityUnitSearchResults getActivityUnitsBySearch(ActivityUnitQuery activityUnitQuery,
 ActivityUnitSearch activityUnitSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

activityUnitQuery - the activity unit query

activityUnitSearch - the activity unit search

Returns:

the activity unit search results

Throws:

NullArgumentException - activityUnitQuery or activityUnitSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - activityUnitQuery or activityUnitSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getActivityUnitQueryFromInspector

ActivityUnitQuery getActivityUnitQueryFromInspector(ItemQueryInspector activityUnitQueryInspector)

Gets an activity unit query from an inspector. The inspector is available from an ActivityUnitSearchResults .

Parameters:

activityUnitQueryInspector - an activity unit query inspector

Returns:

the activity unit query

Throws:

NullArgumentException - activityUnitQueryInspector is null

UnsupportedException - activityUnitQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.