org.osid.financials

Interface FiscalPeriodBusinessSession

All Superinterfaces:

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

public interface FiscalPeriodBusinessSession
extends OsidSession

This session provides methods to retrieve FiscalPeriod to Business mappings. A FiscalPeriod 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	canLookupFiscalPeriodBusinessMappings() Tests if this user can perform lookups of fiscal period/business mappings.
BusinessList	getBusinessesByFiscalPeriod(Id fiscalPeriodId) Gets the Business objects mapped to a FiscalPeriod.
IdList	getBusinessIdsByFiscalPeriod(Id fiscalPeriodId) Gets the Business Ids mapped to a FiscalPeriod.
IdList	getFiscalPeriodIdsByBusiness(Id businessId) Gets the list of FiscalPeriod Ids associated with a Business.
IdList	getFiscalPeriodIdsByBusinesses(IdList businessIds) Gets the list of FiscalPeriod Ids corresponding to a list of Business objects.
FiscalPeriodList	getFiscalPeriodsByBusiness(Id businessId) Gets the list of FiscalPeriods associated with a Business.
FiscalPeriodList	getFiscalPeriodsByBusinesses(IdList businessIds) Gets the list of FiscalPeriods corresponding to a list of Business objects.
void	useComparativeFiscalPeriodBusinessView() 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	usePlenaryFiscalPeriodBusinessView() A complete view of the FiscalPeriod 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

canLookupFiscalPeriodBusinessMappings

boolean canLookupFiscalPeriodBusinessMappings()

Tests if this user can perform lookups of fiscal period/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.

useComparativeFiscalPeriodBusinessView

void useComparativeFiscalPeriodBusinessView()

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.

usePlenaryFiscalPeriodBusinessView

void usePlenaryFiscalPeriodBusinessView()

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

getFiscalPeriodIdsByBusiness

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

Gets the list of FiscalPeriod Ids associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related fiscal period 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.

getFiscalPeriodsByBusiness

FiscalPeriodList getFiscalPeriodsByBusiness(Id businessId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the list of FiscalPeriods associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related fiscal periods

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.

getFiscalPeriodIdsByBusinesses

IdList getFiscalPeriodIdsByBusinesses(IdList businessIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

businessIds - list of business Ids

Returns:

list of fiscal period Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodsByBusinesses

FiscalPeriodList getFiscalPeriodsByBusinesses(IdList businessIds)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

businessIds - list of business Ids

Returns:

list of fiscal periods

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByFiscalPeriod

IdList getBusinessIdsByFiscalPeriod(Id fiscalPeriodId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets the Business Ids mapped to a FiscalPeriod.

Parameters:

fiscalPeriodId - Id of a FiscalPeriod

Returns:

list of businesses

Throws:

NotFoundException - fiscalPeriodId is not found

NullArgumentException - fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessesByFiscalPeriod

BusinessList getBusinessesByFiscalPeriod(Id fiscalPeriodId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the Business objects mapped to a FiscalPeriod.

Parameters:

fiscalPeriodId - Id of a FiscalPeriod

Returns:

list of businesses

Throws:

NotFoundException - fiscalPeriodId is not found

NullArgumentException - fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.