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

This session provides methods to retrieve PostEntry to Business mappings. A PostEntry may appear in multiple Businesses. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupPostEntryBusinessMappings
Description

Tests if this user can perform lookups of entry/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returnboolean false if looking up mappings is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseComparativePostEntryBusinessView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliancemandatory This method is must be implemented.
MethodusePlenaryPostEntryBusinessView
Description

A complete view of the PostEntry and Business returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliancemandatory This method is must be implemented.
MethodgetPostEntryIdsByBusiness
Description

Gets the list of PostEntry Ids associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.id.IdList list of related post entry Ids
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetPostEntriesByBusiness
Description

Gets the list of PostEntry associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.financials.posting.PostEntryList list of related entries
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetPostEntryIdsByBusinesses
Description

Gets the list of PostEntry Ids corresponding to a list of Business objects.

Parametersosid.id.IdListbusinessIds list of catalog Ids
Returnosid.id.IdList list of post entry Ids
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetPostEntriesByBusinesses
Description

Gets the list of PostEntries corresponding to a list of Business objects.

Parametersosid.id.IdListbusinessIds list of catalog Ids
Returnosid.financials.posting.PostEntryList list of entries
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetBusinessIdsByPostEntry
Description

Gets the Business Ids mapped to a PostEntry.

Parametersosid.id.IdpostEntryId Id of a PostEntry
Returnosid.id.IdList list of businesses
ErrorsNOT_FOUND postEntryId is not found
NULL_ARGUMENT postEntryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetBusinessesByPostEntry
Description

Gets the Business objects mapped to a PostEntry.

Parametersosid.id.IdpostEntryId Id of a PostEntry
Returnosid.financials.BusinessList list of businesses
ErrorsNOT_FOUND postEntryId is not found
NULL_ARGUMENT postEntryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.