public interface PayerBusinessAssignmentSession extends OsidSession
This session provides methods to re-assign Payers
to
Business
objects A Payer
may appear in
multiple Business
objects and removing the last reference
to a Payer
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 Payer
to another
Business
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignPayerToBusiness(Id payerId,
Id businessId)
Adds an existing
Payer to a Business. |
boolean |
canAssignPayers()
Tests if this user can alter payer/business mappings.
|
boolean |
canAssignPayerToBusiness(Id businessId)
Tests if this user can alter payer/business mappings.
|
IdList |
getAssignableBusinessIds(Id businessId)
Gets a list of businesses including and under the given business node
in which any payer can be assigned.
|
IdList |
getAssignableBusinessIdsForPayer(Id businessId,
Id payerId)
Gets a list of businesses including and under the given business node
in which a specific payer can be assigned.
|
void |
reassignPayerToBusiness(Id payerId,
Id fromBusinessId,
Id toBusinessId)
Moves a
Payer from one Business to
another. |
void |
unassignPayerFromBusiness(Id payerId,
Id businessId)
Removes a
Payer from a Business. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignPayers()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignPayerToBusiness(Id businessId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.businessId
- the Id
of the Business
false
if mapping is not authorized, true
otherwiseNullArgumentException
- businessId
is
null
mandatory
- This method must be implemented. IdList getAssignableBusinessIds(Id businessId) throws OperationFailedException
businessId
- the Id
of the Business
Ids
NullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableBusinessIdsForPayer(Id businessId, Id payerId) throws OperationFailedException
businessId
- the Id
of the Business
payerId
- the Id
of the Payer
Ids
NullArgumentException
- businessId
or
payerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignPayerToBusiness(Id payerId, Id businessId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Payer
to a Business.
payerId
- the Id
of the Payer
businessId
- the Id
of the Business
AlreadyExistsException
- payerId
is
already assigned to businessId
NotFoundException
- payerId
or
businessId
not foundNullArgumentException
- payerId
or
businessId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignPayerFromBusiness(Id payerId, Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Payer
from a Business.
payerId
- the Id
of the Payer
businessId
- the Id
of the Business
NotFoundException
- payerId
or
businessId
not found or payerId
not
assigned to businessId
NullArgumentException
- payerId
or
businessId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignPayerToBusiness(Id payerId, Id fromBusinessId, Id toBusinessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Payer
from one Business
to
another. Mappings to other Businesses
are unaffected.payerId
- the Id
of the Payer
fromBusinessId
- the Id
of the current
Business
toBusinessId
- the Id
of the destination
Business
NotFoundException
- payerId, fromBusinessId,
or toBusinessId
not found or
payerId
not mapped to fromBusinessId
NullArgumentException
- payerId, fromBusinessId,
or toBusinessId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.