OSID - osid.billing.payment.PaymentAdminSession Service Interface Definition

Interface	osid.billing.payment.PaymentAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.billing.payment.batch.PaymentBatchAdminSession`
Used By	`osid.billing.payment.BillingPaymentManager`
Used By	`osid.billing.payment.BillingPaymentProxyManager`
Description	This session creates, updates, and deletes `Payments` . The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Payment` , a `PaymentForm` is requested using `getPaymentFormForCreate()` specifying the desired payer, customer, and record `Types` or none if no record `Types` are needed. The returned `PaymentForm` 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 `PaymentForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PaymentForm` corresponds to an attempted transaction. For updates, `PaymentForms` are requested to the `Payment` `Id` that is to be updated using `getPaymentFormForUpdate()` . Similarly, the `PaymentForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PaymentForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Payments` . To unmap a `Payment` from the current `Business` , the `PaymentBusinessAssignmentSession` should be used. These delete operations attempt to remove the `Payment` itself thus removing it from all known `Business` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.billing.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePayments
Description	Tests if this user can create `Payments` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Payment` 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 `Payment` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePaymentWithRecordTypes
Description	Tests if this user can create a single `Payment` using the desired record types. While `BillingPaymentManager.getPaymentRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Payment` . Providing an empty array tests if a `Payment` can be created with no records.
Parameters	`osid.type.Type[]`	`paymentRecordTypes`	array of payment record types
Return	`boolean`		`true` if `Payment` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`paymentRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentFormForCreate
Description	Gets the payer form for creating new payments. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`payerId`	the Id of the associated `Payer`
	`osid.id.Id`	`customerId`	the Id of the associated `Customer`
	`osid.type.Type[]`	`paymentRecordTypes`	array of payment record types
Return	`osid.billing.payment.PaymentForm`		the payment form
Errors	NOT_FOUND		`payerId` or `customerId` not found
	NULL_ARGUMENT		`payerId, customerId` , or `paymentRecordTypes` 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	createPayment
Description	Creates a new `Payment` .
Parameters	`osid.billing.payment.PaymentForm`	`paymentForm`	the form for this `Payment`
Return	`osid.billing.payment.Payment`		the new `Payment`
Errors	ILLEGAL_STATE		`paymentForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`paymentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm did not originate from getPaymentFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePayments
Description	Tests if this user can update `Payments` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Payment` 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 `Payment` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentFormForUpdate
Description	Gets the payment form for updating an existing payment. A new payment form should be requested for each update transaction.
Parameters	`osid.id.Id`	`paymentId`	the `Id` of the `Payment`
Return	`osid.billing.payment.PaymentForm`		the payment form
Errors	NOT_FOUND		`paymentId` is not found
	NULL_ARGUMENT		`paymentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePayment
Description	Updates an existing payment.
Parameters	`osid.billing.payment.PaymentForm`	`paymentForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`paymentForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`paymentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm did not originate from getPaymentFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePayments
Description	Tests if this user can delete `Payments` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Payment` 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 `Payment` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePayment
Description	Deletes a `Payment` .
Parameters	`osid.id.Id`	`paymentId`	the `Id` of the `Payment` to remove
Errors	NOT_FOUND		`paymentId` not found
	NULL_ARGUMENT		`paymentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePaymentAliases
Description	Tests if this user can manage `Id` aliases for `Payments` . 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 `Payment` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPayment
Description	Adds an `Id` to a `Payment` for the purpose of creating compatibility. The primary `Id` of the `Payer` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another payment, it is reassigned to the given payment `Id` .
Parameters	`osid.id.Id`	`paymentId`	the `Id` of a `Payment`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`paymentId` not found
	NULL_ARGUMENT		`paymentId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.