org.osid.course

Interface ActivityUnitSearchSession

All Superinterfaces:

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

public interface ActivityUnitSearchSession
extends ActivityUnitQuerySession

This session provides methods for searching among ActivityUnit objects. 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

Methods

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

canSearchActivityUnits, getActivityUnitQuery, getActivityUnitsByQuery, getCourseCatalog, getCourseCatalogId, 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

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.