org.osid.course

Interface ActivityAdminSession

All Superinterfaces:

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

All Known Subinterfaces:

ActivityBatchAdminSession

public interface ActivityAdminSession
extends OsidSession

This session creates, updates, and deletes Activities. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create an Activity, an ActivityForm is requested using getActivityFormForCreate() specifying the desired activity unit, course offering, term, and record Types or none if no record Types are needed. The returned ActivityForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the ActivityForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ActivityForm corresponds to an attempted transaction.

For updates, ActivityForms are requested to the Activity Id that is to be updated using getActivityFormForUpdate(). Similarly, the ActivityForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ActivityForm can only be used once for a successful update and cannot be reused.

The delete operations delete ActivityForms. To unmap an Activity from the current CourseCatalog, the ActivityCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the ActivityForm itself thus removing it from all known CourseCatalog catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlackout(Id activityId, DateTime from, DateTime to) Adds a blackout to the given activity that blocks events in the series.
void	addMeetingTime(Id activityId, DateTime time, Id locationId) Adds a specific meeting time to the given activity.
void	addSchedule(Id activityId, Id scheduleId) Adds a schedule to the activity.
void	aliasActivity(Id activityId, Id aliasId) Adds an Id to an Activity for the purpose of creating compatibility.
boolean	canCreateActivities() Tests if this user can create Activities.
boolean	canCreateActivityWithRecordTypes(Type[] activityRecordTypes) Tests if this user can create a single Activity using the desired record types.
boolean	canDeleteActivities() Tests if this user can delete Activities.
boolean	canManageActivityAliases() Tests if this user can manage Id aliases for Activities.
boolean	canScheduleActivities() Tests if this user can schedule actviities.
boolean	canUpdateActivities() Tests if this user can update Activities.
void	clearBlackout(Id activityId, DateTime from, DateTime to) Clears any blackouts between the given dates inclusive.
void	clearMeetingTimes(Id activityId, DateTime from, DateTime to) Clears any specific meeting times between the given dates inclusive.
Activity	createActivity(ActivityForm activityForm) Creates a new Activity.
void	deleteActivity(Id activityId) Deletes an Activity.
ActivityForm	getActivityFormForCreate(Id activityUnitId, Id courseOfferingId, Id termId, Type[] activityRecordTypes) Gets the activity form for creating new activities.
ActivityForm	getActivityFormForUpdate(Id activityId) Gets the activity form for updating an existing activity.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	removeSchedule(Id activityId, Id scheduleId) Removes a schedule from a given activity.
void	updateActivity(ActivityForm activityForm) Updates an existing activity.

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

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateActivities

boolean canCreateActivities()

Tests if this user can create Activities. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Activity will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:

false if Activity creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateActivityWithRecordTypes

boolean canCreateActivityWithRecordTypes(Type[] activityRecordTypes)

Tests if this user can create a single Activity using the desired record types. While CourseManager.getActivityRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Activity. Providing an empty array tests if an Activity can be created with no records.

Parameters:

activityRecordTypes - array of activity record types

Returns:

true if Activity creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - activityRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getActivityFormForCreate

ActivityForm getActivityFormForCreate(Id activityUnitId,
                                    Id courseOfferingId,
                                    Id termId,
                                    Type[] activityRecordTypes)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the activity form for creating new activities. A new form should be requested for each create transaction.

Parameters:

activityUnitId - an activity unit Id

courseOfferingId - a course offering Id

termId - a term Id

activityRecordTypes - array of activity record types

Returns:

the activity form

Throws:

NotFoundException - activityUnitId, courseOfferingId, or termId is not found

NullArgumentException - activityUnitId, courseOfferingId, termId , or activityRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createActivity

Activity createActivity(ActivityForm activityForm)
                        throws OperationFailedException,
                               PermissionDeniedException

Creates a new Activity.

Parameters:

activityForm - the form for this Activity

Returns:

the new Activity

Throws:

IllegalStateException - activityForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - activityForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - activityForm did not originate from getActivityFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateActivities

boolean canUpdateActivities()

Tests if this user can update Activities. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Activity will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:

false if Activity modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getActivityFormForUpdate

ActivityForm getActivityFormForUpdate(Id activityId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the activity form for updating an existing activity. A new activity form should be requested for each update transaction.

Parameters:

activityId - the Id of the Activity

Returns:

the activity form

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateActivity

void updateActivity(ActivityForm activityForm)
                    throws OperationFailedException,
                           PermissionDeniedException

Updates an existing activity.

Parameters:

activityForm - the form containing the elements to be updated

Throws:

IllegalStateException - activityForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - activityForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - activityForm did not originate from getActivityFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteActivities

boolean canDeleteActivities()

Tests if this user can delete Activities. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Activity will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:

false if Activity deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteActivity

void deleteActivity(Id activityId)
                    throws NotFoundException,
                           OperationFailedException,
                           PermissionDeniedException

Deletes an Activity.

Parameters:

activityId - the Id of the Activity to remove

Throws:

NotFoundException - activityId not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageActivityAliases

boolean canManageActivityAliases()

Tests if this user can manage Id aliases for Activities. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Activity aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasActivity

void aliasActivity(Id activityId,
                 Id aliasId)
                   throws AlreadyExistsException,
                          NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Adds an Id to an Activity for the purpose of creating compatibility. The primary Id of the Activity is deactivityined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another activity, it is reassigned to the given activity Id.

Parameters:

activityId - the Id of an Activity

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is in use as a primary Id

NotFoundException - activityId not found

NullArgumentException - activityId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canScheduleActivities

boolean canScheduleActivities()

Tests if this user can schedule actviities. A return of true does not guarantee successful authorization. A return of false indicates that it is known scheduling 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 create operations to an unauthorized user.

Returns:

false if activity scheduling is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addSchedule

void addSchedule(Id activityId,
               Id scheduleId)
                 throws AlreadyExistsException,
                        NotFoundException,
                        OperationFailedException,
                        PermissionDeniedException

Adds a schedule to the activity.

Parameters:

activityId - an activity Id

scheduleId - a schedule Id

Throws:

AlreadyExistsException - schedule is already part of activity

NotFoundException - activityId or scheduleId is not found

NullArgumentException - activityId or scheduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeSchedule

void removeSchedule(Id activityId,
                  Id scheduleId)
                    throws NotFoundException,
                           OperationFailedException,
                           PermissionDeniedException

Removes a schedule from a given activity.

Parameters:

activityId - an activity Id

scheduleId - the schedule Id

Throws:

NotFoundException - schedule not part of activity

NullArgumentException - activityId or scheduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addMeetingTime

void addMeetingTime(Id activityId,
                  DateTime time,
                  Id locationId)
                    throws NotFoundException,
                           OperationFailedException,
                           PermissionDeniedException

Adds a specific meeting time to the given activity.

Parameters:

activityId - an activity Id

time - a time

locationId - a location Id

Throws:

NotFoundException - activityId or locationId is not found

NullArgumentException - activityId, time, or locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

clearMeetingTimes

void clearMeetingTimes(Id activityId,
                     DateTime from,
                     DateTime to)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Clears any specific meeting times between the given dates inclusive.

Parameters:

activityId - an activity Id

from - start date inclusive

to - end date inclusive

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - activityId is not found

NullArgumentException - activityId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addBlackout

void addBlackout(Id activityId,
               DateTime from,
               DateTime to)
                 throws NotFoundException,
                        OperationFailedException,
                        PermissionDeniedException

Adds a blackout to the given activity that blocks events in the series.

Parameters:

activityId - an activity Id

from - start date inclusive

to - end date inclusive

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - activityId is not found

NullArgumentException - activityId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

clearBlackout

void clearBlackout(Id activityId,
                 DateTime from,
                 DateTime to)
                   throws NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Clears any blackouts between the given dates inclusive.

Parameters:

activityId - an activity Id

from - start date inclusive

to - end date inclusive

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - activityId is not found

NullArgumentException - activityId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.