OSID Logo
OSID Specifications
financials posting package
Version 3.0.0
Interfaceosid.financials.posting.PostEntryBusinessAssignmentSession
Implementsosid.OsidSession
Used Byosid.financials.posting.FinancialsPostingManager
osid.financials.posting.FinancialsPostingProxyManager
Description

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

MethodcanAssignPostEntries
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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignPostEntriesToBusiness
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
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTbusinessId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBusinessIds
Description

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

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

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.id.IdpostEntryIdthe Id of the PostEntry
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENTbusinessId or postEntryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPostEntryToBusiness
Description

Adds an existing PostEntry to a Business .

Parametersosid.id.IdpostEntryIdthe Id of the PostEntry
osid.id.IdbusinessIdthe Id of the Business
ErrorsALREADY_EXISTSpostEntryId is already assigned to businessId
NOT_FOUNDpostEntryId or businessId not found
NULL_ARGUMENTpostEntryId or businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignPostEntryFromBusiness
Description

Removes a PostEntry from a Business .

Parametersosid.id.IdpostEntryIdthe Id of the PostEntry
osid.id.IdbusinessIdthe Id of the Business
ErrorsNOT_FOUNDpostEntryId or businessId not found or postEntryId not assigned to businessId
NULL_ARGUMENTpostEntryId or businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignPostEntryToBusiness
Description

Moves a PostEntry from one Business to another. Mappings to other Businesses are unaffected.

Parametersosid.id.IdpostEntryIdthe Id of the PostEntry
osid.id.IdfromBusinessIdthe Id of the current Business
osid.id.IdtoBusinessIdthe Id of the destination Business
ErrorsALREADY_EXISTSpostEntryId is already assigned to toBusinessId
NOT_FOUNDpostEntryId, fromBusinessId , or toBusinessId not found or postEntryId not mapped to fromBusinessId
NULL_ARGUMENTpostEntryId, fromBusinessId , or toBusinessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.