OSID - osid.course.ActivityAdminSession Service Interface Definition

Interface	osid.course.ActivityAdminSession
Implements	`osid.OsidSession`
Description	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	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateActivities
Description	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.
Return	`boolean`		`false` if `Activity` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateActivityWithRecordTypes
Description	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	`osid.type.Type[]`	`activityRecordTypes`	array of activity record types
Return	`boolean`		`true` if `Activity` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityFormForCreate
Description	Gets the activity form for creating new activities. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
	`osid.id.Id`	`termId`	a term `Id`
	`osid.type.Type[]`	`activityRecordTypes`	array of activity record types
Return	`osid.course.ActivityForm`		the activity form
Errors	NOT_FOUND		`activityUnitId, courseOfferingId,` or `termId` is not found
	NULL_ARGUMENT		`activityUnitId, courseOfferingId, termId` , or `activityRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createActivity
Description	Creates a new `Activity.`
Parameters	`osid.course.ActivityForm`	`activityForm`	the form for this `Activity`
Return	`osid.course.Activity`		the new `Activity`
Errors	ILLEGAL_STATE		`activityForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`activityForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityForm` did not originate from `getActivityFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateActivities
Description	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.
Return	`boolean`		`false` if `Activity` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityFormForUpdate
Description	Gets the activity form for updating an existing activity. A new activity form should be requested for each update transaction.
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity`
Return	`osid.course.ActivityForm`		the activity form
Errors	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateActivity
Description	Updates an existing activity.
Parameters	`osid.course.ActivityForm`	`activityForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`activityForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`activityForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityForm` did not originate from `getActivityFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteActivities
Description	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.
Return	`boolean`		`false` if `Activity` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteActivity
Description	Deletes an `Activity.`
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity` to remove
Errors	NOT_FOUND		`activityId` not found
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageActivityAliases
Description	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.
Return	`boolean`		`false` if `Activity` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasActivity
Description	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	`osid.id.Id`	`activityId`	the `Id` of an `Activity`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`activityId` not found
	NULL_ARGUMENT		`activityId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canScheduleActivities
Description	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.
Return	`boolean`		`false` if activity scheduling is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addSchedule
Description	Adds a schedule to the activity.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`osid.id.Id`	`scheduleId`	a schedule `Id`
Errors	ALREADY_EXISTS		schedule is already part of activity
	NOT_FOUND		`activityId` or `scheduleId` is not found
	NULL_ARGUMENT		`activityId` or `scheduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeSchedule
Description	Removes a schedule from a given activity.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`osid.id.Id`	`scheduleId`	the schedule `Id`
Errors	NOT_FOUND		schedule not part of activity
	NULL_ARGUMENT		`activityId` or `scheduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addMeetingTime
Description	Adds a specific meeting time to the given activity.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
	`osid.calendaring.DateTime`	`time`	a time
	`osid.id.Id`	`locationId`	a location `Id`
Errors	NOT_FOUND		`activityId` or `locationId` is not found
	NULL_ARGUMENT		`activityId, time, or locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearMeetingTimes
Description	Clears any specific meeting times between the given dates inclusive.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
	`osid.calendaring.DateTime`	`from`	start date inclusive
	`osid.calendaring.DateTime`	`to`	end date inclusive
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addBlackout
Description	Adds a blackout to the given activity that blocks events in the series.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
	`osid.calendaring.DateTime`	`from`	start date inclusive
	`osid.calendaring.DateTime`	`to`	end date inclusive
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearBlackout
Description	Clears any blackouts between the given dates inclusive.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
	`osid.calendaring.DateTime`	`from`	start date inclusive
	`osid.calendaring.DateTime`	`to`	end date inclusive
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`activityId` is not found
	NULL_ARGUMENT		`activityId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.