org.osid.financials.posting

Interface PostBusinessSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface PostBusinessSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupPostBusinessMappings() Tests if this user can perform lookups of post/business mappings.
BusinessList	getBusinessesByPost(Id postId) Gets the Business objects mapped to a Post.
IdList	getBusinessIdsByPost(Id postId) Gets the Business Ids mapped to a Post.
IdList	getPostIdsByBusiness(Id businessId) Gets the list of Post Ids associated with a Business.
IdList	getPostIdsByBusinesses(IdList businessIds) Gets the list of Post Ids corresponding to a list of Business objects.
PostList	getPostsByBusiness(Id businessId) Gets the list of Posts associated with a Business.
PostList	getPostsByBusinesses(IdList businessIds) Gets the list of Posts corresponding to a list of Business objects.
void	useComparativePostBusinessView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryPostBusinessView() A complete view of the Post and Business returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupPostBusinessMappings

boolean canLookupPostBusinessMappings()

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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativePostBusinessView

void useComparativePostBusinessView()

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.

Compliance:

mandatory - This method is must be implemented.

usePlenaryPostBusinessView

void usePlenaryPostBusinessView()

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.

Compliance:

mandatory - This method is must be implemented.

getPostIdsByBusiness

IdList getPostIdsByBusiness(Id businessId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the list of Post Ids associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related post Ids

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostsByBusiness

PostList getPostsByBusiness(Id businessId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the list of Posts associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related posts

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostIdsByBusinesses

IdList getPostIdsByBusinesses(IdList businessIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

businessIds - list of business Ids

Returns:

list of post Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostsByBusinesses

PostList getPostsByBusinesses(IdList businessIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

businessIds - list of business Ids

Returns:

list of posts

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByPost

IdList getBusinessIdsByPost(Id postId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the Business Ids mapped to a Post.

Parameters:

postId - Id of a Post

Returns:

list of businesses

Throws:

NotFoundException - postId is not found

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessesByPost

BusinessList getBusinessesByPost(Id postId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the Business objects mapped to a Post.

Parameters:

postId - Id of a Post

Returns:

list of businesses

Throws:

NotFoundException - postId is not found

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.