OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.EntryBusinessAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Entries to Business objects An Entry may appear in multiple Business objects 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
CompliancemandatoryThis 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.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 entry 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.
MethodgetAssignableBusinessIdsForEntry
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.id.IdentryIdthe Id of the Entry
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId or entryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignEntryToBusiness
Description

Adds an existing Entry to a Business.

Parametersosid.id.IdentryIdthe Id of the Entry
osid.id.IdbusinessIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignEntryFromBusiness
Description

Removes an Entry from a Business.

Parametersosid.id.IdentryIdthe Id of the Entry
osid.id.IdbusinessIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignEntryToBusiness
Description

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

Parametersosid.id.IdentryIdthe Id of the Entry
osid.id.IdfromBusinessIdthe Id of the current Business
osid.id.IdtoBusinessIdthe Id of the destination Business
ErrorsNOT_FOUND entryId, fromBusinessId, or toBusinessId not found or entryId not mapped to fromBusinessId
NULL_ARGUMENT entryId, fromBusinessId, or toBusinessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.