public interface BudgetEntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to BudgetEntry
objects in this Business.
This also includes existing budget entries 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
BudgetEntryLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeBudgetEntryNotification(Id notificationId)
Acknowledge a budget entry notification.
|
boolean |
canRegisterForBudgetEntryNotifications()
Tests if this user can register for
BudgetEntry
notifications. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
void |
registerForChangedBudgetEntries()
Registers for notification of updated budget entries.
|
void |
registerForChangedBudgetEntriesForAccount(Id accountId)
Registers for notification of updated budget entries for the given
account.
|
void |
registerForChangedBudgetEntriesForBudget(Id budgetId)
Registers for notification of updated budget entries for the given
budget.
|
void |
registerForChangedBudgetEntry(Id budgetEntryId)
Registers for notification of an updated budget entries.
|
void |
registerForDeletedBudgetEntries()
Registers for notification of deleted budget entries.
|
void |
registerForDeletedBudgetEntriesForAccount(Id accountId)
Registers for notification of deleted budget entries for the given
acount.
|
void |
registerForDeletedBudgetEntriesForBudget(Id budgetId)
Registers for notification of deleted budget entries for the given
budget.
|
void |
registerForDeletedBudgetEntry(Id budgetEntryId)
Registers for notification of a deleted budget entries.
|
void |
registerForNewBudgetEntries()
Register for notifications of new budget entries.
|
void |
registerForNewBudgetEntriesForAccount(Id accountId)
Register for notifications of new budget entries for the given
account.
|
void |
registerForNewBudgetEntriesForBudget(Id budgetId)
Register for notifications of new budget entries for the given budget.
|
void |
reliableBudgetEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableBudgetEntryNotifications()
Unreliable notifications are desired.
|
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 canRegisterForBudgetEntryNotifications()
BudgetEntry
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 reliableBudgetEntryNotifications()
acknowledgeBudgetEntryNotification()
.mandatory
- This method is must be implemented. void unreliableBudgetEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeBudgetEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBudgetEntries() throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.newBudgetEntries()
is invoked when a new
BudgetEntry
appears in this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBudgetEntriesForBudget(Id budgetId) throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.newBudgetEntries()
is invoked when
a new BudgetEntry
appears in this business.budgetId
- the Id
of the Budget
to
monitorNullArgumentException
- budgetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBudgetEntriesForAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.newBudgetEntries()
is
invoked when a new BudgetEntry
appears in this
business.accountId
- the Id
of the Account
to monitorNullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBudgetEntries() throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.changedBudgetEntries()
is invoked when a
budget entry in this business is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBudgetEntriesForBudget(Id budgetId) throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.changedBudgetEntries()
is
invoked when the specified budget entry in this business is changed.budgetId
- the Id
of the Budget
to
monitorNullArgumentException
- budgetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBudgetEntriesForAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.changedBudgetEntries()
is
invoked when the specified budget entry in this business is changed.accountId
- the Id
of the Account
to monitorNullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBudgetEntry(Id budgetEntryId) throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.changedBudgetEntries()
is invoked when the
specified budget entry in this business is changed.budgetEntryId
- the Id
of the BudgetEntry
to monitorNullArgumentException
- budgetEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBudgetEntries() throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.deletedBudgetEntries()
is invoked when a
budget entry is deleted or removed from this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBudgetEntriesForBudget(Id budgetId) throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.deletedBudgetEntries()
is
invoked when the specified budget entry is deleted or removed from
this business.budgetId
- the Id
of the Budget
to
monitorNullArgumentException
- budgetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBudgetEntriesForAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.deletedBudgetEntries()
is
invoked when the specified budget entry is deleted or removed from
this business.accountId
- the Id
of the Account
to monitorNullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBudgetEntry(Id budgetEntryId) throws OperationFailedException, PermissionDeniedException
BudgetEntryReceiver.deletedBudgetEntries()
is invoked when the
specified budget entry is deleted or removed from this business.budgetEntryId
- the Id
of the BudgetEntry
to monitorNullArgumentException
- budgetEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.