public interface FiscalPeriodNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to FiscalPeriod
objects in this Business.
This also includes existing fiscal periods that may appear or disappear
due to changes in the Business
hierarchy, This session is
intended for consumers needing to synchronize their state with this
service without the use of polling. Notifications are cancelled when this
session is closed.
The two views defined in this session correspond to the views in the
FiscalPeriodLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForFiscalPeriodNotifications()
Tests if this user can register for
FiscalPeriod
notifications. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
void |
registerForChangedFiscalPeriod(Id fiscalPeriodId)
Registers for notification of an updated fiscal period.
|
void |
registerForChangedFiscalPeriods()
Registers for notification of updated fiscal periods.
|
void |
registerForDeletedFiscalPeriod(Id fiscalPeriodId)
Registers for notification of a deleted fiscal period.
|
void |
registerForDeletedFiscalPeriods()
Registers for notification of deleted fiscal periods.
|
void |
registerForNewFiscalPeriods()
Register for notifications of new fiscal periods.
|
void |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
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 canRegisterForFiscalPeriodNotifications()
FiscalPeriod
notifications. 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 opt not
to offer notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. void registerForNewFiscalPeriods() throws OperationFailedException, PermissionDeniedException
FiscalPeriodReceiver.newFiscalPeriods()
is invoked when a new
FiscalPeriod
appears in this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedFiscalPeriods() throws OperationFailedException, PermissionDeniedException
FiscalPeriodReceiver.changedFiscalPeriods()
is invoked when a
fiscal period in this business is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
FiscalPeriodReceiver.changedFiscalPeriods()
is invoked when
the specified fiscal period in this business is changed.fiscalPeriodId
- the Id
of the
FiscalPeriod
to monitorNullArgumentException
- fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedFiscalPeriods() throws OperationFailedException, PermissionDeniedException
FiscalPeriodReceiver.deletedFiscalPeriods()
is invoked when a
fiscal period is deleted or removed from this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
FiscalPeriodReceiver.deletedFiscalPeriods()
is invoked when
the specified fiscal period is deleted or removed from this business.fiscalPeriodId
- the Id
of the
FiscalPeriod
to monitorNullArgumentException
- fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.