org.osid.learning

Interface ActivitySearchSession

All Superinterfaces:

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

public interface ActivitySearchSession
extends ActivityQuerySession

This session provides methods for searching Activity objects. The search query is constructed using the ActivityQuery. The activity record Type also specifies the record for the activity query.

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

This session defines views that offer differing behaviors for searching.

• federated objective bank view: searches include activities in objective banks of which this objective bank is a ancestor in the objective bank hierarchy
• isolated objective bank view: searches are restricted to activities in this objective bank

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

Method Summary

Methods

Modifier and Type	Method and Description
ActivitySearchResults	getActivitiesBySearch(ActivityQuery activityQuery, ActivitySearch activitiesearch) Gets the search results matching the given search query using the given search.
ActivityQuery	getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector) Gets an activity query from an inspector.
ActivitySearch	getActivitySearch() Gets an activity search.
ActivitySearchOrder	getActivitySearchOrder() Gets an activity search order.

Methods inherited from interface org.osid.learning.ActivityQuerySession

canSearchActivities, getActivitiesByQuery, getActivityQuery, getObjectiveBank, getObjectiveBankId, useFederatedObjectiveBankView, useIsolatedObjectiveBankView

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

getActivitySearch

ActivitySearch getActivitySearch()

Gets an activity search.

Returns:

the activity search

Compliance:

mandatory - This method must be implemented.

getActivitySearchOrder

ActivitySearchOrder getActivitySearchOrder()

Gets an activity search order. The ActivitySearchOrder is supplied to a ActivitySearch to specify the ordering of results.

Returns:

the activity search order

Compliance:

mandatory - This method must be implemented.

getActivitiesBySearch

ActivitySearchResults getActivitiesBySearch(ActivityQuery activityQuery,
                                          ActivitySearch activitiesearch)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

activityQuery - the activity query

activitiesearch - the activity search

Returns:

the returned search results

Throws:

NullArgumentException - activityQuery or activitiesearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - activitiesearch or activityQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getActivityQueryFromInspector

ActivityQuery getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector)

Gets an activity query from an inspector. The inspector is available from an ActivitySearchResults.

Parameters:

activityQueryInspector - an activity bank query inspector

Returns:

the activity query

Throws:

NullArgumentException - activityQueryInspector is null

UnsupportedException - activityQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.