OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.EntryBusinessAssignmentSession
Implementsosid.OsidSession
Used Byosid.billing.BillingManager
osid.billing.BillingProxyManager
Description

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

MethodcanAssignEntries
Description

Tests if this user can alter entry/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
Compliancemandatory This method must be implemented.
MethodcanAssignEntriesToBusiness
Description

Tests if this user can alter entry/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.IdbusinessId the Id of the Business
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT businessId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableBusinessIds
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.id.IdList list of assignable business Ids
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableBusinessIdsForEntry
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
osid.id.IdentryId the Id of the Entry
Returnosid.id.IdList list of assignable business Ids
ErrorsNULL_ARGUMENT businessId or entryId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignEntryToBusiness
Description

Adds an existing Entry to a Business.

Parametersosid.id.IdentryId the Id of the Entry
osid.id.IdbusinessId the Id of the Business
ErrorsALREADY_EXISTS entryId is already assigned to businessId
NOT_FOUND entryId or businessId not found
NULL_ARGUMENT entryId or businessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignEntryFromBusiness
Description

Removes an Entry from a Business.

Parametersosid.id.IdentryId the Id of the Entry
osid.id.IdbusinessId the Id of the Business
ErrorsNOT_FOUND entryId or businessId not found or entryId not assigned to businessId
NULL_ARGUMENT entryId or businessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignEntryToBusiness
Description

Moves an Entry from one Business to another. Mappings to other Businesses are unaffected.

Parametersosid.id.IdentryId the Id of the Entry
osid.id.IdfromBusinessId the Id of the current Business
osid.id.IdtoBusinessId the Id of the destination Business
ErrorsALREADY_EXISTS entryId already assigned to toBusinessId
NOT_FOUND entryId, fromBusinessId, or toBusinessId not found or entryId not mapped to fromBusinessId
NULL_ARGUMENT entryId, fromBusinessId, or toBusinessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.