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

Interface	osid.course.syllabus.DocetAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.syllabus.batch.DocetBatchAdminSession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session creates, updates, and deletes `Docets` . 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 `Docet` , a `DocetForm` is requested using `getDocetFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `DocetForm` 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 `DocetForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `DocetForm` corresponds to an attempted transaction. For updates, `DocetForms` are requested to the `DocetForm` `Id` that is to be updated using `geDocetFormForUpdate()` . Similarly, the `DocetForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `DocetForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Docet` . To unmap a `Docet` from the current `CourseCatalog` , the `DocetCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `Docet` 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	canCreateDocets
Description	Tests if this user can create `Docets` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Docet` 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 `Docet` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDocetWithRecordTypes
Description	Tests if this user can create a single `Docet` using the desired record types. While `CourseSyllabusManager.getDocetRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Docet` . Providing an empty array tests if a `Docet` can be created with no records.
Parameters	`osid.type.Type[]`	`docetRecordTypes`	array of docet record types
Return	`boolean`		`true` if `Docet` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`docetRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDocetFormForCreate
Description	Gets the docet form for creating new docets. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`moduleId`	a module `Id`
	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
	`osid.type.Type[]`	`docetRecordTypes`	array of docet record types
Return	`osid.course.syllabus.DocetForm`		the docet form
Errors	NOT_FOUND		`moduleId` or `activityUnitId` is not found
	NULL_ARGUMENT		`moduleId, acticvtyUnitId` , or `docetRecordTypes` 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	createDocet
Description	Creates a new `Docet` .
Parameters	`osid.course.syllabus.DocetForm`	`docetForm`	the form for this `Docet`
Return	`osid.course.syllabus.Docet`		the new `Docet`
Errors	ILLEGAL_STATE		`docetForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`docetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`docetForm` did not originate from `getDocetFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateDocets
Description	Tests if this user can update `Docets` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Docet` 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 `Docet` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDocetFormForUpdate
Description	Gets the docet form for updating an existing docet. A new docet form should be requested for each update transaction.
Parameters	`osid.id.Id`	`docetId`	the `Id` of the `Docet`
Return	`osid.course.syllabus.DocetForm`		the docet form
Errors	NOT_FOUND		`docetId` is not found
	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateDocet
Description	Updates an existing docet.
Parameters	`osid.course.syllabus.DocetForm`	`docetForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`docetForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`docetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`docetForm` did not originate from `getDocetFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteDocets
Description	Tests if this user can delete `Docets` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Docet` 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 `Docet` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteDocet
Description	Deletes a `Docet` .
Parameters	`osid.id.Id`	`docetId`	the `Id` of the `Docet` to remove
Errors	NOT_FOUND		`docetId` not found
	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageDocetAliases
Description	Tests if this user can manage `Id` aliases for `Docets` . 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 `Docet` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasDocet
Description	Adds an `Id` to a `Docet` for the purpose of creating compatibility. The primary `Id` of the `Docet` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another docet, it is reassigned to the given docet `Id` .
Parameters	`osid.id.Id`	`docetId`	the `Id` of a `Docet`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`docetId` not found
	NULL_ARGUMENT		`docetId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceDocets
Description	Tests if this user can order `Docets` . 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 `Docet` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveDocetAhead
Description	Reorders docets in a module by moving the specified docet in front of a reference docet.
Parameters	`osid.id.Id`	`docetId`	the `Id` of a `Docet`
	`osid.id.Id`	`moduleId`	the `Id` of a `Module`
	`osid.id.Id`	`referenceId`	the reference docet `Id`
Errors	NOT_FOUND		`docetId, moduleId` , or `referenceId` not found or, `docetId` or `referenceId` not related to `moduleId`
	NULL_ARGUMENT		`docetId, moduleId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveDocetBehind
Description	Reorders docets in a module by moving the specified docet behind a reference docet.
Parameters	`osid.id.Id`	`docetId`	the `Id` of a `Docet`
	`osid.id.Id`	`moduleId`	the `Id` of a `Module`
	`osid.id.Id`	`referenceId`	the reference docet `Id`
Errors	NOT_FOUND		`docetId, moduleId` , or `referenceId` not found or, `docetId` or `referenceId` not related to `moduleId`
	NULL_ARGUMENT		`docetId, moduleId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderDocets
Description	Reorders a set of docets in a module.
Parameters	`osid.id.Id[]`	`docetIds`	the `Ids` for a set of `Docets`
Parameters	`osid.id.Id`	`moduleId`	the `Id` of a `Module`
Errors	NOT_FOUND		`docetId` not found or, a `docetId` not related to `moduleId`
	NULL_ARGUMENT		`docetIds` or `moduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.