public interface FiscalPeriodLookupSession extends OsidSession
This session defines methods for retrieving fiscal periods.
This lookup session defines several views:
FiscalPeriods
with the FiscalPeriodAdminSession.
The methods useFederatedBusinessView()
and
useIsolatedBusinessView()
behave as a radio group and one should
be selected before invoking any lookup 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupFiscalPeriods()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeFiscalPeriodView()
mandatory
- This method is must be implemented. void usePlenaryFiscalPeriodView()
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.mandatory
- This method is must be implemented. void useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. FiscalPeriod getFiscalPeriod(Id fiscalPeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.fiscalPeriodId
- the Id
of the
FiscalPeriod
to retrieve FiscalPeriod
NotFoundException
- no FiscalPeriod
found with the given Id
NullArgumentException
- fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FiscalPeriodList getFiscalPeriodsByIds(IdList fiscalPeriodIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.fiscalPeriodIds
- the list of Ids
to retrieve FiscalPeriod
listNotFoundException
- an Id was
not foundNullArgumentException
- fiscalPeriodIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FiscalPeriodList getFiscalPeriodsByGenusType(Type fiscalPeriodGenusType) throws OperationFailedException, PermissionDeniedException
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.fiscalPeriodGenusType
- a fiscal period genus type FiscalPeriod
listNullArgumentException
- fiscalPeriodGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FiscalPeriodList getFiscalPeriodsByParentGenusType(Type fiscalPeriodGenusType) throws OperationFailedException, PermissionDeniedException
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.fiscalPeriodGenusType
- a fiscal period genus type FiscalPeriod
listNullArgumentException
- fiscalPeriodGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FiscalPeriodList getFiscalPeriodsByRecordType(Type fiscalPeriodRecordType) throws OperationFailedException, PermissionDeniedException
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.fiscalPeriodRecordType
- a fiscal period record type FiscalPeriod
listNullArgumentException
- fiscalPeriodRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FiscalPeriodList getFiscalPeriodsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
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.date
- a date FiscalPeriod
listNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FiscalPeriodList getFiscalPeriods() throws OperationFailedException, PermissionDeniedException
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. FiscalPeriods
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.