OSID - osid.acknowledgement.CreditAdminSession Service Interface Definition

Interface	osid.acknowledgement.CreditAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Credits.` 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 `Credit,` a `CreditForm` is requested using `getCreditFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `CreditForm` 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 `CreditForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CreditForm` corresponds to an attempted transaction. For updates, `CreditForms` are requested to the `Credit` `Id` that is to be updated using `getCreditFormForUpdate().` Similarly, the `CreditForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CreditForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Credits.` To unmap a `Credit` from the current `Billing,` the `CreditBillingAssignmentSession` should be used. These delete operations attempt to remove the `Credit` itself thus removing it from all known `Billing` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getBillingId
Description	Gets the `Billing` `Id` associated with this session.
Return	`osid.id.Id`		the `Billing Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBilling
Description	Gets the `Billing` associated with this session.
Return	`osid.acknowledgement.Billing`		the billing
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCredits
Description	Tests if this user can create credits. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Credit` 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 `Credit` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCreditWithRecordTypes
Description	Tests if this user can create a single `Credit` using the desired record types. While `AcknowledgementManager.getCreditRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Credit.` Providing an empty array tests if a `Credit` can be created with no records.
Parameters	`osid.type.Type[]`	`creditRecordTypes`	array of credit record types
Return	`boolean`		`true` if `Credit` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`creditRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditFormForCreate
Description	Gets the credit form for creating new credits. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`referenceId`	the reference `Id`
	`osid.id.Id`	`resourceId`	the resource `Id`
	`osid.type.Type[]`	`creditRecordTypes`	array of credit record types to be included in the create operation or an empty list if none
Return	`osid.acknowledgement.CreditForm`		the credit form
Errors	NOT_FOUND		`referenceId` or `resourceId` is not found
	NULL_ARGUMENT		`referenceId, resourceId` or `creditRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		cannot get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createCredit
Description	Creates a new `Credit.`
Parameters	`osid.acknowledgement.CreditForm`	`creditForm`	the form for this `Credit`
Return	`osid.acknowledgement.Credit`		the new `Credit`
Errors	ILLEGAL_STATE		`creditForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`creditForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`creditForm` did not originate from `getCreditFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCredits
Description	Tests if this user can update credits. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Credit` 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 `Credit` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreditFormForUpdate
Description	Gets the credit form for updating an existing credit. A new credit form should be requested for each update transaction.
Parameters	`osid.id.Id`	`creditId`	the `Id` of the `Credit`
Return	`osid.acknowledgement.CreditForm`		the credit form
Errors	NOT_FOUND		`creditId` is not found
	NULL_ARGUMENT		`creditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCredit
Description	Updates an existing credit.
Parameters	`osid.acknowledgement.CreditForm`	`creditForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`creditForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`creditForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`creditForm` did not originate from `getCreditFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCredits
Description	Tests if this user can delete credits. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Credit` 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 `Credit` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCredit
Description	Deletes a `Credit.`
Parameters	`osid.id.Id`	`creditId`	the `Id` of the `Credit` to remove
Errors	NOT_FOUND		`creditId` not found
	NULL_ARGUMENT		`creditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCreditAliases
Description	Tests if this user can manage `Id` aliases for `Credits.` 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 `Credit` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCredit
Description	Adds an `Id` to a `Credit` for the purpose of creating compatibility. The primary `Id` of the `Credit` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another credit, it is reassigned to the given credit `Id.`
Parameters	`osid.id.Id`	`creditId`	the `Id` of a `Credit`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`creditId` not found
	NULL_ARGUMENT		`creditId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.