OSID - osid.course.program.CredentialAdminSession Service Interface Definition

Interface	osid.course.program.CredentialAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Credentials.` 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 `Credential,` a `CredentialForm` is requested using `getCredentialFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CredentialForm` 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 `CredentialForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CredentialForm` corresponds to an attempted transaction. For updates, `CredentialForms` are requested to the `CredentialForm` `Id` that is to be updated using `getCredentialFormForUpdate().` Similarly, the `CredentialForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CredentialForm` can only be used once for a successful update and cannot be reused. The delete operations delete `CredentialForms.` To unmap a `CredentialForm` from the current `CourseCatalog,` the `CredentialFormCourseCatalogAssignmentSession` should be used. These delete operations attempt to remove the `CredentialForm` 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	canCreateCredentials
Description	Tests if this user can create `Credentials.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `credential` 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 `Credential` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCredentialWithRecordTypes
Description	Tests if this user can create a single `Credential` using the desired record types. While `CourseProgramManager.getCredentialRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Credential.` Providing an empty array tests if a `Credential` can be created with no records.
Parameters	`osid.type.Type[]`	`credentialRecordTypes`	array of credential record types
Return	`boolean`		`true` if `Credential` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`credentialRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialFormForCreate
Description	Gets the credential form for creating new credentials. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`credentialRecordTypes`	array of credential record types
Return	`osid.course.program.CredentialForm`		the credential form
Errors	NULL_ARGUMENT		`credentialRecordTypes` 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	createCredential
Description	Creates a new `Credential.`
Parameters	`osid.course.program.CredentialForm`	`credentialForm`	the form for this `Credential`
Return	`osid.course.program.Credential`		the new `Credential`
Errors	ILLEGAL_STATE		`credentialForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`credentialForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`credentialForm` did not originate from `getCredentialFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCredentials
Description	Tests if this user can update `Credentials.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `credential` 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 `credential` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialFormForUpdate
Description	Gets the credential form for updating an existing credential. A new credential form should be requested for each update transaction.
Parameters	`osid.id.Id`	`credentialId`	the `Id` of the `credential`
Return	`osid.course.program.CredentialForm`		the credential form
Errors	NOT_FOUND		`credentialId` is not found
	NULL_ARGUMENT		`credentialId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCredential
Description	Updates an existing credential.
Parameters	`osid.course.program.CredentialForm`	`credentialForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`credentialForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`credentialForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`credentialForm did not originate from getCredentialFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCredentials
Description	Tests if this user can delete `Credentials.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Credential` 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 `credential` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCredential
Description	Deletes a `Credential.`
Parameters	`osid.id.Id`	`credentialId`	the `Id` of the `Credential` to remove
Errors	NOT_FOUND		`credentialId` not found
	NULL_ARGUMENT		`credentialId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCredentialAliases
Description	Tests if this user can manage `Id` aliases for `Credentials.` 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 `credential` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCredential
Description	Adds an `Id` to a `credential` for the purpose of creating compatibility. The primary `Id` of the `Credential` 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, it is reassigned to the given credential `Id.`
Parameters	`osid.id.Id`	`credentialId`	the `Id` of a `credential`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`credentialId` not found
	NULL_ARGUMENT		`credentialId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.