org.osid.learning

Interface ActivityLookupSession

All Superinterfaces:

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

public interface ActivityLookupSession
extends OsidSession

This session provides methods for retrieving Activity objects. The Activity represents something to perform in order to achieve a learning objective.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated objective bank view: All activity methods in this session operate, retrieve and pertain to activities defined explicitly in the current objective bank. Using an isolated view is useful for managing activities with the ActivityAdminSession.
• federated objective bank view: All activity methods in this session operate, retrieve and pertain to all activities defined in this objective bank and any other objective banks implicitly available in this objective bank through objective bank inheritence.

Activities may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Activity.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupActivities() Tests if this user can perform Activity lookups.
ActivityList	getActivities() Gets all Activities.
ActivityList	getActivitiesByAsset(Id assetId) Gets the activities for the given asset.
ActivityList	getActivitiesByAssets(IdList assetIds) Gets the activities for the given asset.
ActivityList	getActivitiesByGenusType(Type activityGenusType) Gets an ActivityList corresponding to the given activity genus Type which does not include activities of genus types derived from the specified Type.
ActivityList	getActivitiesByIds(IdList activityIds) Gets an ActivityList corresponding to the given IdList.
ActivityList	getActivitiesByParentGenusType(Type activityGenusType) Gets an ActivityList corresponding to the given activity genus Type and include any additional activity with genus types derived from the specified Type.
ActivityList	getActivitiesByRecordType(Type activityRecordType) Gets a ActivityList containing the given activity record Type.
ActivityList	getActivitiesForObjective(Id objectiveId) Gets the activities for the given objective.
ActivityList	getActivitiesForObjectives(IdList objectiveIds) Gets the activities for the given objectives.
Activity	getActivity(Id activityId) Gets the Activity specified by its Id.
ObjectiveBank	getObjectiveBank() Gets the ObjectiveBank associated with this session.
Id	getObjectiveBankId() Gets the ObjectiveBank Id associated with this session.
void	useComparativeActivityView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedObjectiveBankView() Federates the view for methods in this session.
void	useIsolatedObjectiveBankView() Isolates the view for methods in this session.
void	usePlenaryActivityView() A complete view of the Activity returns is desired.

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.

canLookupActivities

boolean canLookupActivities()

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

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeActivityView

void useComparativeActivityView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryActivityView

void usePlenaryActivityView()

A complete view of the Activity returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is 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 lookups to this objective bank only.

Compliance:

mandatory - This method is must be implemented.

getActivity

Activity getActivity(Id activityId)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets the Activity specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Activity may have a different Id than requested, such as the case where a duplicate Id was assigned to a Activity and retained for compatibility.

Parameters:

activityId - Id of the Activity

Returns:

the activity

Throws:

NotFoundException - activityId not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getActivitiesByIds

ActivityList getActivitiesByIds(IdList activityIds)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets an ActivityList corresponding to the given IdList. In plenary mode, the returned list contains all of the activities specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Activities may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

activityIds - the list of Ids to retrieve

Returns:

the returned Activity list

Throws:

NotFoundException - an Id was not found

NullArgumentException - activityIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesByGenusType

ActivityList getActivitiesByGenusType(Type activityGenusType)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets an ActivityList corresponding to the given activity genus Type which does not include activities of genus types derived from the specified Type. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session.

Parameters:

activityGenusType - an activity genus type

Returns:

the returned Activity list

Throws:

NullArgumentException - activityGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesByParentGenusType

ActivityList getActivitiesByParentGenusType(Type activityGenusType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets an ActivityList corresponding to the given activity genus Type and include any additional activity with genus types derived from the specified Type. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session.

Parameters:

activityGenusType - an activity genus type

Returns:

the returned Activity list

Throws:

NullArgumentException - activityGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesByRecordType

ActivityList getActivitiesByRecordType(Type activityRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a ActivityList containing the given activity record Type. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session.

Parameters:

activityRecordType - an activity record type

Returns:

the returned Activity list

Throws:

NullArgumentException - activityRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesForObjective

ActivityList getActivitiesForObjective(Id objectiveId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the activities for the given objective. In plenary mode, the returned list contains all of the activities mapped to the objective Id or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Activities may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

objectiveId - Id of the Objective

Returns:

list of enrollments

Throws:

NotFoundException - objectiveId not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getActivitiesForObjectives

ActivityList getActivitiesForObjectives(IdList objectiveIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the activities for the given objectives. In plenary mode, the returned list contains all of the activities specified in the objective Id list, in the order of the list, including duplicates, or an error results if a course offering Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Activities may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

objectiveIds - list of objective Ids

Returns:

list of activities

Throws:

NotFoundException - an objectiveId not found

NullArgumentException - objectiveIdList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getActivitiesByAsset

ActivityList getActivitiesByAsset(Id assetId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the activities for the given asset. In plenary mode, the returned list contains all of the activities mapped to the asset Id or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Activities may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

assetId - Id of an Asset

Returns:

list of activities

Throws:

NotFoundException - assetId not found

NullArgumentException - assetId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getActivitiesByAssets

ActivityList getActivitiesByAssets(IdList assetIds)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the activities for the given asset. In plenary mode, the returned list contains all of the activities mapped to the asset Id or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Activities may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

assetIds - Ids of Assets

Returns:

list of activities

Throws:

NotFoundException - an assetId not found

NullArgumentException - assetIdList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getActivities

ActivityList getActivities()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets all Activities. In plenary mode, the returned list contains all known activites or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session.

Returns:

a ActivityList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.