OSID - osid.course.registration.ActivityBundleAdminSession Service Interface Definition

Interface	osid.course.registration.ActivityBundleAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `ActivityBundles.` 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 `ActivityBundle,` an `ActivityBundleForm` is requested using `getActivityBundleFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ActivityBundleForm` 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 `ActivityBundleForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ActivityBundleForm` corresponds to an attempted transaction. For updates, `ActivityBundleForms` are requested to the `ActivityBundle` `Id` that is to be updated using `getActivityBundleFormForUpdate().` Similarly, the `ActivityBundleForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ActivityBundleForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ActivityBundles.` To unmap an `ActivityBundle` from the current `CourseCatalog,` the `ActivityBundleCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `ActivityBundle` 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	canCreateActivityBundles
Description	Tests if this user can create `ActivityBundles.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `ActivityBundle` 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 `ActivityBundle` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateActivityBundleWithRecordTypes
Description	Tests if this user can create a single `ActivityBundle` using the desired record types. While `CourseRegistrationManager.getActivityBundleRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ActivityBundle.` Providing an empty array tests if an `ActivityBundle` can be created with no records.
Parameters	`osid.type.Type[]`	`activityBundleRecordTypes`	array of types
Return	`boolean`		`true` if `ActivityBundle` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityBundleRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	canCreateActivityBundlesForCourseOffering
Description	Tests if this user can create a single `ActivityBundle` for a course offering.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Return	`boolean`		`true` if `ActivityBundle` creation for the specified `CourseOffering` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityBundleFormForCreate
Description	Gets the course form for creating new activity bundles. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Parameters	`osid.type.Type[]`	`activityBundleRecordTypes`	array of types
Return	`osid.course.registration.ActivityBundleForm`		the activity bundle form
Errors	NOT_FOUND		`courseOfferingId` is not found
	NULL_ARGUMENT		`courseOfferingId` or `activityBundleRecordTypes` 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	createActivityBundle
Description	Creates a new `ActivityBundle.`
Parameters	`osid.course.registration.ActivityBundleForm`	`activityBundleForm`	the form for this `ActivityBundle`
Return	`osid.course.registration.ActivityBundle`		the new `ActivityBundle`
Errors	ILLEGAL_STATE		`activityBundleForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`activityBundleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityBundleForm` did not originate from `getActivityBundleFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateActivityBundles
Description	Tests if this user can update `ActivityBundles.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `ActivityBundle` 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 `ActivityBundle` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityBundleFormForUpdate
Description	Gets the activity bundle form for updating an existing activity bundle. A new activity bundle form should be requested for each update transaction.
Parameters	`osid.id.Id`	`activityBundleId`	the `Id` of the `ActivityBundle`
Return	`osid.course.registration.ActivityBundleForm`		the activity bundle form
Errors	NOT_FOUND		`activityBundleId` is not found
	NULL_ARGUMENT		`activityBundleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateActivityBundle
Description	Updates an existing activity bundle.
Parameters	`osid.course.registration.ActivityBundleForm`	`activityBundleForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`activityBundleForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`activityBundleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`activityBundleForm did not originate from getActivityBundleFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteActivityBundles
Description	Tests if this user can delete `ActivityBundles.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `ActivityBundle` 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 `ActivityBundle` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteActivityBundle
Description	Deletes an `ActivityBundle.`
Parameters	`osid.id.Id`	`activityBundleId`	the `Id` of the `ActivityBundle` to remove
Errors	NOT_FOUND		`activityBundleId` not found
	NULL_ARGUMENT		`activityBundleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageActivityBundleAliases
Description	Tests if this user can manage `Id` aliases for `ActivityBundles.` 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 `ActivityBundle` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasActivityBundle
Description	Adds an `Id` to an `ActivityBundle` for the purpose of creating compatibility. The primary `Id` of the `Course` 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 bundle, it is reassigned to the given activity bundle `Id.`
Parameters	`osid.id.Id`	`activityBundleId`	the `Id` of an `ActivityBundle`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`activityBundleId` not found
	NULL_ARGUMENT		`activityBundleId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.