OSID - osid.course.chronicle.CredentialEntryAdminSession Service Interface Definition

Interface	osid.course.chronicle.CredentialEntryAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `CredentialEntries.` 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 `CredentialEntry,` a `CredentialEntryForm` is requested using `getCredentialEntryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CredentialEntryForm` 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 `CredentialEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CredentialEntryForm` corresponds to an attempted transaction. For updates, `CredentialEntryForms` are requested to the `CredentialEntry` `Id` that is to be updated using `getCredentialEntryFormForUpdate().` Similarly, the `CredentialEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CredentialEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `CredentialEntries.` To unmap a `CredentialEntry` from the current `CourseCatalog,` the `CredentialEntryCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `CredentialEntry` 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	canCreateCredentialEntries
Description	Tests if this user can create `CredentialEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CredentialEntry` 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 `CredentialEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCredentialEntryWithRecordTypes
Description	Tests if this user can create a single `Porgram` using the desired record types. While `CourseChronicleManager.getCredentialEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CredentialEntry.` Providing an empty array tests if a `CredentialEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`credentialEntryRecordTypes`	array of credential entry record types
Return	`boolean`		`true` if `CredentialEntry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`credentialEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntryFormForCreate
Description	Gets the credential entry form for creating new credential entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`credentialId`	a credential `Id`
	`osid.id.Id`	`resourceId`	a student `Id`
	`osid.type.Type[]`	`credentialEntryRecordTypes`	array of credential entry record types
Return	`osid.course.chronicle.CredentialEntryForm`		the credential entry form
Errors	NOT_FOUND		`credentialId` or `resourceId` is not found
	NULL_ARGUMENT		`credentialId, resourceId` , or `credentialEntryRecordTypes` 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	createCredentialEntry
Description	Creates a new `CredentialEntry.`
Parameters	`osid.course.chronicle.CredentialEntryForm`	`credentialEntryForm`	the form for this `CredentialEntry`
Return	`osid.course.chronicle.CredentialEntry`		the new `CredentialEntry`
Errors	ILLEGAL_STATE		`credentialEntryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`credentialEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`credentialEntryForm` did not originate from `getCredentialEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCredentialEntries
Description	Tests if this user can update `CredentialEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CredentialEntry` 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 `CredentialEntry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntryFormForUpdate
Description	Gets the credential entry form for updating an existing credential entry. A new credential entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`credentialEntryId`	the `Id` of the `CredentialEntry`
Return	`osid.course.chronicle.CredentialEntryForm`		the credential entry form
Errors	NOT_FOUND		`credentialEntryId` is not found
	NULL_ARGUMENT		`credentialEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCredentialEntry
Description	Updates an existing credential entry.
Parameters	`osid.course.chronicle.CredentialEntryForm`	`credentialEntryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`credentialEntryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`credentialEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`credentialEntryForm` did not originate from `getCredentialEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCredentialEntries
Description	Tests if this user can delete `CredentialEntries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CredentialEntry` 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 `CredentialEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCredentialEntry
Description	Deletes a `CredentialEntry.`
Parameters	`osid.id.Id`	`credentialEntryId`	the `Id` of the `CredentialEntry` to remove
Errors	NOT_FOUND		`credentialEntryId` not found
	NULL_ARGUMENT		`credentialEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCredentialEntryAliases
Description	Tests if this user can manage `Id` aliases for `CredentialEntries.` 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 `CredentialEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCredentialEntry
Description	Adds an `Id` to a `CredentialEntry` for the purpose of creating compatibility. The primary `Id` of the `CredentialEntry` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another credential entry, it is reassigned to the given credential entry `Id.`
Parameters	`osid.id.Id`	`credentialEntryId`	the `Id` of a `CredentialEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`credentialEntryId` not found
	NULL_ARGUMENT		`credentialEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.