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

This session provides methods to retrieve Post to Business mappings. A Post may appear in multiple Business objects. 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
MethodcanLookupPostBusinessMappings
Description

Tests if this user can perform lookups of post/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
CompliancemandatoryThis method must be implemented.
MethoduseComparativePostBusinessView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryPostBusinessView
Description

A complete view of the Post 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.

CompliancemandatoryThis method is must be implemented.
MethodgetPostIdsByBusiness
Description

Gets the list of Post Ids associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.id.IdListlist of related post Ids
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPostsByBusiness
Description

Gets the list of Posts associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.financials.posting.PostListlist of related posts
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPostIdsByBusinesses
Description

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

Parametersosid.id.IdListbusinessIdslist of business Ids
Returnosid.id.IdListlist of post Ids
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPostsByBusinesses
Description

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

Parametersosid.id.IdListbusinessIdslist of business Ids
Returnosid.financials.posting.PostListlist of posts
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdsByPost
Description

Gets the Business Ids mapped to a Post.

Parametersosid.id.IdpostId Id of a Post
Returnosid.id.IdListlist of businesses
ErrorsNOT_FOUND postId is not found
NULL_ARGUMENT postId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByPost
Description

Gets the Business objects mapped to a Post.

Parametersosid.id.IdpostId Id of a Post
Returnosid.financials.BusinessListlist of businesses
ErrorsNOT_FOUND postId is not found
NULL_ARGUMENT postId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.