org.osid.learning

Interface ActivityQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

ActivitySearchSession

public interface ActivityQuerySession
extends OsidSession

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.

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
boolean	canSearchActivities() Tests if this user can perform Activity searches.
ActivityList	getActivitiesByQuery(ActivityQuery activityQuery) Gets a list of Activities matching the given activity query.
ActivityQuery	getActivityQuery() Gets an activity query.
ObjectiveBank	getObjectiveBank() Gets the ObjectiveBank associated with this session.
Id	getObjectiveBankId() Gets the ObjectiveBank Id associated with this session.
void	useFederatedObjectiveBankView() Federates the view for methods in this session.
void	useIsolatedObjectiveBankView() 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

getObjectiveBankId

Id getObjectiveBankId()

Gets the ObjectiveBank Id associated with this session.

Returns:

the ObjectiveBank Id associated with this session

Compliance:

mandatory - This method must be implemented.

getObjectiveBank

ObjectiveBank getObjectiveBank()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the ObjectiveBank associated with this session.

Returns:

the ObjectiveBank associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchActivities

boolean canSearchActivities()

Tests if this user can perform Activity searches. 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 opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedObjectiveBankView

void useFederatedObjectiveBankView()

Federates the view for methods in this session. A federated view will include activities in objective banks which are children of this objective bank in the objective bank hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedObjectiveBankView

void useIsolatedObjectiveBankView()

Isolates the view for methods in this session. An isolated view restricts searches to this objective bank only.

Compliance:

mandatory - This method is must be implemented.

getActivityQuery

ActivityQuery getActivityQuery()

Gets an activity query.

Returns:

the activity query

Compliance:

mandatory - This method must be implemented.

getActivitiesByQuery

ActivityList getActivitiesByQuery(ActivityQuery activityQuery)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets a list of Activities matching the given activity query.

Parameters:

activityQuery - the activity query

Returns:

the returned ActivityList

Throws:

NullArgumentException - activityQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - activityQuery is not of this service

Compliance:

mandatory - This method must be implemented.