OSID - osid.course.syllabus.ModuleAdminSession Service Interface Definition

Interface	osid.course.syllabus.ModuleAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.syllabus.batch.ModuleBatchAdminSession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session creates, updates, and deletes `Modules`. 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 a `Module`, a `ModuleForm` is requested using `getModuleFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ModuleForm` 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 `ModuleForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ModuleForm` corresponds to an attempted transaction. For updates, `ModuleForms` are requested to the `ModuleForm` `Id` that is to be updated using `getModuleFormForUpdate()`. Similarly, the `ModuleForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ModuleForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Modules`. To unmap a `Module` from the current `CourseCatalog`, the `ModuleCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `Module` 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	canCreateModules
Description	Tests if this user can create modules. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Module` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Module` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateModuleWithRecordTypes
Description	Tests if this user can create a single `Module` using the desired record types. While `CourseSyllabusManager.getModuleRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Module`. Providing an empty array tests if a `Module` can be created with no records.
Parameters	`osid.type.Type[]`	`moduleRecordTypes`	array of module record types
Return	`boolean`		`true` if `Module` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`moduleRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getModuleFormForCreate
Description	Gets the module form for creating new modules. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`syllabusId`	a syllabus `Id`
Parameters	`osid.type.Type[]`	`moduleRecordTypes`	array of module record types
Return	`osid.course.syllabus.ModuleForm`		the module form
Errors	NOT_FOUND		`syllabusId` is not found
	NULL_ARGUMENT		`syllabusId` or `moduleRecordTypes` 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	createModule
Description	Creates a new `Module`.
Parameters	`osid.course.syllabus.ModuleForm`	`moduleForm`	the form for this `Module`
Return	`osid.course.syllabus.Module`		the new `Module`
Errors	ILLEGAL_STATE		`moduleForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`moduleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`moduleForm` did not originate from `getModuleFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateModules
Description	Tests if this user can update modules. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Module` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Module` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getModuleFormForUpdate
Description	Gets the module form for updating an existing module. A new module form should be requested for each update transaction.
Parameters	`osid.id.Id`	`moduleId`	the `Id` of the `Module`
Return	`osid.course.syllabus.ModuleForm`		the module form
Errors	NOT_FOUND		`moduleId` is not found
	NULL_ARGUMENT		`moduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateModule
Description	Updates an existing module.
Parameters	`osid.course.syllabus.ModuleForm`	`moduleForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`moduleForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`moduleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`moduleForm` did not originate from `getModuleFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteModules
Description	Tests if this user can delete modules. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Module` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Module` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteModule
Description	Deletes a `Module`.
Parameters	`osid.id.Id`	`moduleId`	the `Id` of the `Module` to remove
Errors	NOT_FOUND		`moduleId` not found
	NULL_ARGUMENT		`moduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageModuleAliases
Description	Tests if this user can manage `Id` aliases for `Modules`. 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 `Module` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasModule
Description	Adds an `Id` to a `Module` for the purpose of creating compatibility. The primary `Id` of the `Module` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another module, it is reassigned to the given module `Id`.
Parameters	`osid.id.Id`	`moduleId`	the `Id` of a `Module`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`moduleId` not found
	NULL_ARGUMENT		`moduleId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceModules
Description	Tests if this user can order `Modules`. 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 sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `Module` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveModuleAhead
Description	Reorders modules in a syllabus by moving the specified module in front of a reference module.
Parameters	`osid.id.Id`	`moduleId`	the `Id` of a `Module`
	`osid.id.Id`	`syllabusId`	the `Id` of a `Syllabus`
	`osid.id.Id`	`referenceId`	the reference module `Id`
Errors	NOT_FOUND		`moduleId, syllabusId`, or `referenceId` not found or, `moduleId` or `referenceId` not related to `syllabusId`
	NULL_ARGUMENT		`moduleId, syllabusId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveModuleBehind
Description	Reorders modules in a syllabus by moving the specified module behind a reference module.
Parameters	`osid.id.Id`	`moduleId`	the `Id` of a `Module`
	`osid.id.Id`	`syllabusId`	the `Id` of a `Syllabus`
	`osid.id.Id`	`referenceId`	the reference module `Id`
Errors	NOT_FOUND		`moduleId, syllabusId`, or `referenceId` not found or, `moduleId` or `referenceId` not related to `syllabusId`
	NULL_ARGUMENT		`moduleId, syllabusId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderModules
Description	Reorders a set of modules in a syllabus.
Parameters	`osid.id.Id[]`	`moduleIds`	the `Ids` for a set of `Modules`
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of a `Syllabus`
Errors	NOT_FOUND		`moduleId` not found or, a `moduleId` not related to `syllabusId`
	NULL_ARGUMENT		`moduleIds` or `syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.