OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.AccountBusinessAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Accounts to Business objects An Account may appear in multiple Business objects and removing the last reference to an Account 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 an Account to another Business is not a copy operation (eg: does not change its Id ).

MethodcanAssignAccounts
Description

Tests if this user can alter account/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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignAccountToBusiness
Description

Tests if this user can alter account/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.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT businessId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBusinessIds
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBusinessIdsForAccount
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.id.IdaccountIdthe Id of the Account
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId or accountId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAccountToBusiness
Description

Adds an existing Account to a Business.

Parametersosid.id.IdaccountIdthe Id of the Account
osid.id.IdbusinessIdthe Id of the Business
ErrorsALREADY_EXISTS accountId is already assigned to businessId
NOT_FOUND accountId or businessId not found
NULL_ARGUMENT accountId or businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAccountFromBusiness
Description

Removes an Account from a Business.

Parametersosid.id.IdaccountIdthe Id of the Account
osid.id.IdbusinessIdthe Id of the Business
ErrorsNOT_FOUND accountId or businessId not found or accountId not assigned to businessId
NULL_ARGUMENT accountId or businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.