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

Interface	osid.billing.payment.PayerAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Payers.` 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 `Payer,` a `PayerForm` is requested using `getPayerFormForCreate()` specifying the desired resource and record `Types` or none if no record `Types` are needed. The returned `PayerForm` 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 `PayerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PayerForm` corresponds to an attempted transaction. For updates, `PayerForms` are requested to the `Payer` `Id` that is to be updated using `getPayerFormForUpdate().` Similarly, the `PayerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PayerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Payers.` To unmap a `Payer` from the current `Business,` the `PayerBusinessAssignmentSession` should be used. These delete operations attempt to remove the `Payer` 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	canCreatePayers
Description	Tests if this user can create `Payers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Payer` 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 `Payer` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePayerWithRecordTypes
Description	Tests if this user can create a single `Payer` using the desired record types. While `BillingPaymentManager.getPayerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Payer.` Providing an empty array tests if a `Payer` can be created with no records.
Parameters	`osid.type.Type[]`	`payerRecordTypes`	array of payer record types
Return	`boolean`		`true` if `Payer` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`payerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPayerFormForCreate
Description	Gets the payer form for creating new payers. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.type.Type[]`	`payerRecordTypes`	array of payer record types
Return	`osid.billing.payment.PayerForm`		the payer form
Errors	NOT_FOUND		`resourceId` is not found
	NULL_ARGUMENT		`payerRecordTypes` or `resourceId` 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	createPayer
Description	Creates a new `Payer.`
Parameters	`osid.billing.payment.PayerForm`	`payerForm`	the form for this `Payer`
Return	`osid.billing.payment.Payer`		the new `Payer`
Errors	ILLEGAL_STATE		`payerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`payerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`payerForm did not originate from getPayerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePayers
Description	Tests if this user can update `Payers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Payer` 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 `Payer` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPayerFormForUpdate
Description	Gets the payer form for updating an existing payer. A new payer form should be requested for each update transaction.
Parameters	`osid.id.Id`	`payerId`	the `Id` of the `Payer`
Return	`osid.billing.payment.PayerForm`		the payer form
Errors	NOT_FOUND		`payerId` is not found
	NULL_ARGUMENT		`payerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePayer
Description	Updates an existing payer.
Parameters	`osid.billing.payment.PayerForm`	`payerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`payerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`payerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`payerForm did not originate from getPayerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePayers
Description	Tests if this user can delete `Payers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Payer` 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 `Payer` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePayer
Description	Deletes a `Payer.`
Parameters	`osid.id.Id`	`payerId`	the `Id` of the `Payer` to remove
Errors	NOT_FOUND		`payerId` not found
	NULL_ARGUMENT		`payerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePayerAliases
Description	Tests if this user can manage `Id` aliases for `Payers.` 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 `Payer` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPayer
Description	Adds an `Id` to a `Payer` 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 payer, it is reassigned to the given payer `Id.`
Parameters	`osid.id.Id`	`payerId`	the `Id` of a `Payer`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`payerId` not found
	NULL_ARGUMENT		`payerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.