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

This session provides methods to re-assign PostEntries to Business objects. A PostEntry may appear in multiple Business objects 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.

Returnboolean false 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
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 post 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.
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_ARGUMENT businessId 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_EXISTS postEntryId is already assigned to businessId
NOT_FOUND postEntryId or businessId not found
NULL_ARGUMENT postEntryId 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_FOUND postEntryId or businessId not found or postEntryId not assigned to businessId
NULL_ARGUMENT postEntryId or businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.