public interface FiscalPeriodSmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A FiscalPeriodQuery
can be retrieved from this
session and mapped to this Business
to create a virtual
collection of FiscalPeriods.
The fiscal periods may be
sequenced using the FiscalPeriodSearchOrder
from this
session.
This Business
has a default query that matches any
fiscal period and a default search order that specifies no sequencing. The
queries may be examined using a FiscalPeriodQueryInspector.
The query may be modified by converting the inspector back to a
FiscalPeriodQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyFiscalPeriodQuery(FiscalPeriodQuery fiscalPeriodQuery)
Applies a fiscal period query to this business.
|
void |
applyFiscalPeriodSequencing(FiscalPeriodSearchOrder fiscalPeriodSearchOrder)
Applies a fiscal period search order to this business.
|
boolean |
canManageSmartBusinesses()
Tests if this user can manage smart businesses.
|
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
FiscalPeriodQuery |
getFiscalPeriodQuery()
Gets a fiscal period query.
|
FiscalPeriodQuery |
getFiscalPeriodQueryFromInspector(FiscalPeriodQueryInspector fiscalPeriodQueryInspector)
Gets a fiscal period query from an inspector.
|
FiscalPeriodSearchOrder |
getFiscalPeriodSearchOrder()
Gets a fiscal period search order.
|
FiscalPeriodQueryInspector |
inspectFiscalPeriodQuery()
Gets a fiscal period query inspector for this business.
|
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 canManageSmartBusinesses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart business management is not
authorized, true
otherwisemandatory
- This method must be implemented. FiscalPeriodQuery getFiscalPeriodQuery()
mandatory
- This method must be implemented. FiscalPeriodSearchOrder getFiscalPeriodSearchOrder()
mandatory
- This method must be implemented. void applyFiscalPeriodQuery(FiscalPeriodQuery fiscalPeriodQuery) throws OperationFailedException, PermissionDeniedException
fiscalPeriodQuery
- the fiscal period queryNullArgumentException
- fiscalPeriodQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- fiscalPeriodQuery
not of this servicemandatory
- This method must be implemented. FiscalPeriodQueryInspector inspectFiscalPeriodQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyFiscalPeriodSequencing(FiscalPeriodSearchOrder fiscalPeriodSearchOrder) throws OperationFailedException, PermissionDeniedException
fiscalPeriodSearchOrder
- the fiscal period search orderNullArgumentException
- fiscalPeriodSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- fiscalPeriodSearchOrder
not of this servicemandatory
- This method must be implemented. FiscalPeriodQuery getFiscalPeriodQueryFromInspector(FiscalPeriodQueryInspector fiscalPeriodQueryInspector)
fiscalPeriodQueryInspector
- a query inspectorNullArgumentException
-
fiscalPeriodQueryInspector
is null
UnsupportedException
-
fiscalPeriodQueryInspector
is not of this servicemandatory
- This method must be implemented.