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

Interface	osid.course.syllabus.SyllabusAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.course.syllabus.batch.SyllabusBatchAdminSession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session creates, updates, and deletes `Syllabi`. 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 `Syllabus`, a `SyllabusForm` is requested using `getSyllabusFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `SyllabusForm` 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 `SyllabusForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `SyllabusForm` corresponds to an attempted transaction. For updates, `SyllabusForms` are requested to the `Syllabus` `Id` that is to be updated using `getSyllabusFormForUpdate()`. Similarly, the `SyllabusForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `SyllabusForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Syllabi`. To unmap a `Syllabus` from the current `CourseCatalog`, the `SyllabusCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `SyllabusForm` 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	canCreateSyllabi
Description	Tests if this user can create syllabi. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Syllabus` 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 `Syllabus` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSyllabusWithRecordTypes
Description	Tests if this user can create a single `Syllabus` using the desired record types. While `CourseSyllabusManager.getSyllabusRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Syllabus`. Providing an empty array tests if a `Syllabus` can be created with no records.
Parameters	`osid.type.Type[]`	`syllabusRecordTypes`	array of syllabus record types
Return	`boolean`		`true` if `Syllabus` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`syllabusRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusFormForCreate
Description	Gets the syllabus form for creating new syllabi. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`courseId`	the `Id` for the course
Parameters	`osid.type.Type[]`	`syllabusRecordTypes`	array of syllabus record types
Return	`osid.course.syllabus.SyllabusForm`		the syllabus form
Errors	NOT_FOUND		`courseId` is not found
	NULL_ARGUMENT		`courseId` or `syllabusRecordTypes` 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	createSyllabus
Description	Creates a new `Syllabus`.
Parameters	`osid.course.syllabus.SyllabusForm`	`syllabusForm`	the form for this `Syllabus`
Return	`osid.course.syllabus.Syllabus`		the new `Syllabus`
Errors	ILLEGAL_STATE		`syllabusForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NOT_FOUND		`courseId` is not found
	NULL_ARGUMENT		`syllabusForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`syllabusForm` did not originate from `getSyllabusFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSyllabi
Description	Tests if this user can update syllabi. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Syllabus` 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 `Syllabus` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusFormForUpdate
Description	Gets the syllabus form for updating an existing syllabus. A new syllabus form should be requested for each update transaction.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of the `Syllabus`
Return	`osid.course.syllabus.SyllabusForm`		the syllabus form
Errors	NOT_FOUND		`syllabusId` is not found
	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSyllabus
Description	Updates an existing syllabus.
Parameters	`osid.course.syllabus.SyllabusForm`	`syllabusForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`syllabusForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`syllabusForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`syllabusForm` did not originate from `getSyllabusFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSyllabi
Description	Tests if this user can delete syllabi. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Syllabus` 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 `Syllabus` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSyllabus
Description	Deletes a `Syllabus`.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of the `Syllabus` to remove
Errors	NOT_FOUND		`syllabusId` not found
	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSyllabusAliases
Description	Tests if this user can manage `Id` aliases for `Comnents`. 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 `Syllabus` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSyllabus
Description	Adds an `Id` to a `Syllabus` for the purpose of creating compatibility. The primary `Id` of the `Syllabus` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another syllabus, it is reassigned to the given syllabus `Id`.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of a `Syllabus`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`syllabusId` not found
	NULL_ARGUMENT		`syllabusId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.