OSID - osid.billing.CustomerAdminSession Service Interface Definition

Interface	osid.billing.CustomerAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Customers.` 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 `Customer,` a `CustomerForm` is requested using `getCustomerFormForCreate()` specifying the desired resource and record `Types` or none if no record `Types` are needed. The returned `CustomerForm` 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 `CustomerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CustomerForm` corresponds to an attempted transaction. For updates, `CustomerForms` are requested to the `Customer` `Id` that is to be updated using `getCustomerFormForUpdate().` Similarly, the `CustomerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CustomerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Customers.` To unmap a `Customer` from the current `Business,` the `CustomerBusinessAssignmentSession` should be used. These delete operations attempt to remove the `Customer` 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	canCreateCustomers
Description	Tests if this user can create `Customers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Customer` 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 `Customer` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCustomerWithRecordTypes
Description	Tests if this user can create a single `Customer` using the desired record types. While `BillingManager.getCustomerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Customer.` Providing an empty array tests if a `Customer` can be created with no records.
Parameters	`osid.type.Type[]`	`customerRecordTypes`	array of customer record types
Return	`boolean`		`true` if `Customer` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`customerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerFormForCreate
Description	Gets the customer form for creating new customers. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.type.Type[]`	`customerRecordTypes`	array of customer record types
Return	`osid.billing.CustomerForm`		the customer form
Errors	NOT_FOUND		`resourceId` is not found
	NULL_ARGUMENT		`customerRecordTypes` 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	createCustomer
Description	Creates a new `Customer.`
Parameters	`osid.billing.CustomerForm`	`customerForm`	the form for this `Customer`
Return	`osid.billing.Customer`		the new `Customer`
Errors	ILLEGAL_STATE		`customerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`customerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`customerForm did not originate from getCustomerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCustomers
Description	Tests if this user can update `Customers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Customer` 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 `Customer` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerFormForUpdate
Description	Gets the customer form for updating an existing customer. A new customer form should be requested for each update transaction.
Parameters	`osid.id.Id`	`customerId`	the `Id` of the `Customer`
Return	`osid.billing.CustomerForm`		the customer form
Errors	NOT_FOUND		`customerId` is not found
	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCustomer
Description	Updates an existing customer.
Parameters	`osid.billing.CustomerForm`	`customerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`customerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`customerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`customerForm did not originate from getCustomerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCustomers
Description	Tests if this user can delete `Customers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Customer` 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 `Customer` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCustomer
Description	Deletes a `Customer.`
Parameters	`osid.id.Id`	`customerId`	the `Id` of the `Customer` to remove
Errors	NOT_FOUND		`customerId` not found
	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCustomerAliases
Description	Tests if this user can manage `Id` aliases for `Customers.` 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 `Customer` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCustomer
Description	Adds an `Id` to a `Customer` for the purpose of creating compatibility. The primary `Id` of the `Customer` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another customer, it is reassigned to the given customer `Id.`
Parameters	`osid.id.Id`	`customerId`	the `Id` of a `Customer`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`customerId` not found
	NULL_ARGUMENT		`customerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.