org.osid.financials

Interface FiscalPeriodLookupSession

All Superinterfaces:

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

public interface FiscalPeriodLookupSession
extends OsidSession

This session defines methods for retrieving fiscal periods.

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
• isolated business view: All fiscal period methods in this session operate, retrieve and pertain to fiscal periods defined explicitly in the current business. Using an isolated view is useful for managing FiscalPeriods with the FiscalPeriodAdminSession.
• federated business view: All fiscal period lookup methods in this session operate, retrieve and pertain to all fiscal periods defined in this business and any other fiscal periods implicitly available in this business through business inheritence.

The methods useFederatedBusinessView() and useIsolatedBusinessView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupFiscalPeriods() Tests if this user can perform FiscalPeriod lookups.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
FiscalPeriod	getFiscalPeriod(Id fiscalPeriodId) Gets the FiscalPeriod specified by its Id.
FiscalPeriodList	getFiscalPeriods() Gets all FiscalPeriods.
FiscalPeriodList	getFiscalPeriodsByDate(DateTime date) Gets a FiscalPeriodList containing the given date .
FiscalPeriodList	getFiscalPeriodsByGenusType(Type fiscalPeriodGenusType) Gets a FiscalPeriodList corresponding to the given fiscal period genus Type which does not include fiscal periods of types derived from the specified Type.
FiscalPeriodList	getFiscalPeriodsByIds(IdList fiscalPeriodIds) Gets a FiscalPeriodList corresponding to the given IdList.
FiscalPeriodList	getFiscalPeriodsByParentGenusType(Type fiscalPeriodGenusType) Gets a FiscalPeriodList corresponding to the given fiscal period genus Type and include any additional fiscal periods with genus types derived from the specified Type.
FiscalPeriodList	getFiscalPeriodsByRecordType(Type fiscalPeriodRecordType) Gets a FiscalPeriodList containing the given fiscal period record Type.
void	useComparativeFiscalPeriodView() 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	useFederatedBusinessView() Federates the view for methods in this session.
void	useIsolatedBusinessView() Isolates the view for methods in this session.
void	usePlenaryFiscalPeriodView() A complete view of the FiscalPeriod 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

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupFiscalPeriods

boolean canLookupFiscalPeriods()

Tests if this user can perform FiscalPeriod lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeFiscalPeriodView

void useComparativeFiscalPeriodView()

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.

usePlenaryFiscalPeriodView

void usePlenaryFiscalPeriodView()

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

useFederatedBusinessView

void useFederatedBusinessView()

Federates the view for methods in this session. A federated view will include fiscal periods in catalogs which are children of this catalog in the business hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBusinessView

void useIsolatedBusinessView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this business only.

Compliance:

mandatory - This method is must be implemented.

getFiscalPeriod

FiscalPeriod getFiscalPeriod(Id fiscalPeriodId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the FiscalPeriod specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned FiscalPeriod may have a different Id than requested, such as the case where a duplicate Id was assigned to a FiscalPeriod and retained for compatibility.

Parameters:

fiscalPeriodId - the Id of the FiscalPeriod to retrieve

Returns:

the returned FiscalPeriod

Throws:

NotFoundException - no FiscalPeriod found with the given Id

NullArgumentException - fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodsByIds

FiscalPeriodList getFiscalPeriodsByIds(IdList fiscalPeriodIds)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets a FiscalPeriodList corresponding to the given IdList. In plenary mode, the returned list contains all of the fiscal periods specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible FiscalPeriods may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

fiscalPeriodIds - the list of Ids to retrieve

Returns:

the returned FiscalPeriod list

Throws:

NotFoundException - an Id was not found

NullArgumentException - fiscalPeriodIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodsByGenusType

FiscalPeriodList getFiscalPeriodsByGenusType(Type fiscalPeriodGenusType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets a FiscalPeriodList corresponding to the given fiscal period genus Type which does not include fiscal periods of types derived from the specified Type. In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.

Parameters:

fiscalPeriodGenusType - a fiscal period genus type

Returns:

the returned FiscalPeriod list

Throws:

NullArgumentException - fiscalPeriodGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodsByParentGenusType

FiscalPeriodList getFiscalPeriodsByParentGenusType(Type fiscalPeriodGenusType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Gets a FiscalPeriodList corresponding to the given fiscal period genus Type and include any additional fiscal periods with genus types derived from the specified Type. In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.

Parameters:

fiscalPeriodGenusType - a fiscal period genus type

Returns:

the returned FiscalPeriod list

Throws:

NullArgumentException - fiscalPeriodGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodsByRecordType

FiscalPeriodList getFiscalPeriodsByRecordType(Type fiscalPeriodRecordType)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a FiscalPeriodList containing the given fiscal period record Type. In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.

Parameters:

fiscalPeriodRecordType - a fiscal period record type

Returns:

the returned FiscalPeriod list

Throws:

NullArgumentException - fiscalPeriodRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodsByDate

FiscalPeriodList getFiscalPeriodsByDate(DateTime date)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a FiscalPeriodList containing the given date . In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.

Parameters:

date - a date

Returns:

the returned FiscalPeriod list

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFiscalPeriods

FiscalPeriodList getFiscalPeriods()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets all FiscalPeriods. In plenary mode, the returned list contains all known fiscal periods or an error results. Otherwise, the returned list may contain only those fiscal periods that are accessible through this session.

Returns:

a list of FiscalPeriods

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.