org.osid.billing

Interface CustomerBusinessAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CustomerBusinessAssignmentSession
extends OsidSession

This session provides methods to re-assign Customers to Business objects A Customer may appear in multiple Business objects and removing the last reference to a Customer is the equivalent of deleting it. Each Business may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Customer to another Business is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignCustomerToBusiness(Id customerId, Id businessId) Adds an existing Customer to a Business.
boolean	canAssignCustomers() Tests if this user can alter customer/business mappings.
boolean	canAssignCustomerToBusiness(Id businessId) Tests if this user can alter customer/business mappings.
IdList	getAssignableBusinessIds(Id businessId) Gets a list of businesses including and under the given business node in which any customer can be assigned.
IdList	getAssignableBusinessIdsForCustomer(Id businessId, Id customerId) Gets a list of businesses including and under the given business node in which a specific customer can be assigned.
void	unassignCustomerFromBusiness(Id customerId, Id businessId) Removes a Customer from a Business.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignCustomers

boolean canAssignCustomers()

Tests if this user can alter customer/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignCustomerToBusiness

boolean canAssignCustomerToBusiness(Id businessId)

Tests if this user can alter customer/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parameters:

businessId - the Id of the Business

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - businessId is null

Compliance:

mandatory - This method must be implemented.

getAssignableBusinessIds

IdList getAssignableBusinessIds(Id businessId)
                                throws OperationFailedException

Gets a list of businesses including and under the given business node in which any customer can be assigned.

Parameters:

businessId - the Id of the Business

Returns:

list of assignable business Ids

Throws:

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableBusinessIdsForCustomer

IdList getAssignableBusinessIdsForCustomer(Id businessId,
                                         Id customerId)
                                           throws OperationFailedException

Gets a list of businesses including and under the given business node in which a specific customer can be assigned.

Parameters:

businessId - the Id of the Business

customerId - the Id of the Customer

Returns:

list of assignable business Ids

Throws:

NullArgumentException - businessId or customerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignCustomerToBusiness

void assignCustomerToBusiness(Id customerId,
                            Id businessId)
                              throws AlreadyExistsException,
                                     NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Adds an existing Customer to a Business.

Parameters:

customerId - the Id of the Customer

businessId - the Id of the Business

Throws:

AlreadyExistsException - customerId is already assigned to businessId

NotFoundException - customerId or businessId not found

NullArgumentException - customerId or businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCustomerFromBusiness

void unassignCustomerFromBusiness(Id customerId,
                                Id businessId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Removes a Customer from a Business.

Parameters:

customerId - the Id of the Customer

businessId - the Id of the Business

Throws:

NotFoundException - customerId or businessId not found or customerId not assigned to businessId

NullArgumentException - customerId or businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.