OSID - osid.authorization.QualifierAdminSession Service Interface Definition

Interface	osid.authorization.QualifierAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.authorization.batch.QualifierBatchAdminSession`
Used By	`osid.authorization.AuthorizationManager`
Used By	`osid.authorization.AuthorizationProxyManager`
Description	This session creates, updates, and deletes `Qualifiers`. 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 `Qualifier`, a `QualifierForm` is requested using `getQualifierFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `QualifierForm` 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 `QualifierForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `QualifierForm` corresponds to an attempted transaction. For updates, `QualifierForms` are requested to the `Qualifier` `Id` that is to be updated using `getQualifierFormForUpdate()`. Similarly, the `QualifierForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `QualifierForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Qualifiers`. To unmap a `Qualifier` from the current `Vault`, the `QualifierVaultAssignmentSession` should be used. These delete operations attempt to remove the `Qualifier` itself thus removing it from all known `Vault` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getVaultId
Description	Gets the `Vault` `Id` associated with this session.
Return	`osid.id.Id`		the `Vault Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getVault
Description	Gets the `Vault` associated with this session.
Return	`osid.authorization.Vault`		the `Vault` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateQualifiers
Description	Tests if this user can create `Qualifiers`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Qualifier` 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 `Qualifier` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateQualifierWithRecordTypes
Description	Tests if this user can create a single `Qualifier` using the desired record types. While `AuthorizationManager.getQualifierRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Qualifier`. Providing an empty array tests if a `Qualifier` can be created with no records.
Parameters	`osid.type.Type[]`	`qualifierRecordTypes`	array of qualifier record types
Return	`boolean`		`true` if `Qualifier` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`qualifierRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierFormForCreate
Description	Gets the qualifier form for creating new qualifiers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`qualifierRecordTypes`	array of qualifier record types
Return	`osid.authorization.QualifierForm`		the qualifier form
Errors	NULL_ARGUMENT		`qualifierRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createQualifier
Description	Creates a new `Qualifier`.
Parameters	`osid.authorization.QualifierForm`	`qualifierForm`	the form for this `Qualifier`
Return	`osid.authorization.Qualifier`		the new `Qualifier`
Errors	ILLEGAL_STATE		`qualifierForm` already used for a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`qualifierForms` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`qualifierForm` did not originate from `getQualifierFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateQualifiers
Description	Tests if this user can update `Qualifiers`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Qualifier` 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 `Qualifier` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierFormForUpdate
Description	Gets the qualifier form for updating an existing qualifier. A new qualifier form should be requested for each update transaction.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of the `Qualifier`
Return	`osid.authorization.QualifierForm`		the qualifier form
Errors	NOT_FOUND		`qualifierId` is not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateQualifier
Description	Updates an existing qualifier.
Parameters	`osid.authorization.QualifierForm`	`qualifierForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`qualifierForm` already used for an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`qualifierForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`qualifierForm` did not originate from `getQualifierFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteQualifiers
Description	Tests if this user can delete `Qualifiers`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Qualifier` 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 `Qualifier` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteQualifier
Description	Deletes a `Qualifier`.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of the `Qualifier` to remove
Errors	NOT_FOUND		`qualifierId` not found
	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageQualifierAliases
Description	Tests if this user can manage `Id` aliases for `Qualifiers`. 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 `Qualifier` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasQualifier
Description	Adds an `Id` to a `Qualifier` for the purpose of creating compatibility. The primary `Id` of the `Qualifier` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another qualifier, it is reassigned to the given qualifier `Id`.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of a `Qualifier`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`qualifierId` not found
	NULL_ARGUMENT		`qualifierId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.