public interface BudgetNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Budget
objects in this Business.
This
also includes existing budgets 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
BudgetLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeBudgetNotification(Id notificationId)
Acknowledge a budget notification.
|
boolean |
canRegisterForBudgetNotifications()
Tests if this user can register for
Budget
notifications. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
void |
registerFoChangedBudgetsForActivity(Id activityId)
Registers for notification of updated budgets for the given activity.
|
void |
registerFoChangedBudgetsForFiscalPeriod(Id fiscalPeriodId)
Registers for notification of updated budgets for the given fiscal
period.
|
void |
registerForChangedBudget(Id budgetId)
Registers for notification of an updated budget.
|
void |
registerForChangedBudgets()
Registers for notification of updated budgets.
|
void |
registerForDeletedBudget(Id budgetId)
Registers for notification of a deleted budget.
|
void |
registerForDeletedBudgets()
Registers for notification of deleted budgets.
|
void |
registerForDeletedBudgetsForActivity(Id activityId)
Registers for notification of deleted budgets for the given activity.
|
void |
registerForDeletedBudgetsForFiscalPeriod(Id fiscalPeriodId)
Registers for notification of deleted budgets for the given fiscal
period.
|
void |
registerForNewBudgets()
Register for notifications of new budgets.
|
void |
registerForNewBudgetsForActivity(Id activityId)
Register for notifications of new budgets for the given activity.
|
void |
registerForNewBudgetsForFiscalPeriod(Id fiscalPeriodId)
Register for notifications of new budgets for the given fiscal period.
|
void |
reliableBudgetNotifications()
Reliable notifications are desired.
|
void |
unreliableBudgetNotifications()
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 canRegisterForBudgetNotifications()
Budget
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 reliableBudgetNotifications()
acknowledgeBudgetNotification()
.mandatory
- This method is must be implemented. void unreliableBudgetNotifications()
mandatory
- This method is must be implemented. void acknowledgeBudgetNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBudgets() throws OperationFailedException, PermissionDeniedException
BudgetReceiver.newBudgets()
is invoked when a new
Budget
appears in this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBudgetsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
BudgetReceiver.newBudgets()
is invoked when a new
Budget
appears in this business.activityId
- the Id
of the Activity
to monitorNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBudgetsForFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
BudgetReceiver.newBudgets()
is invoked when a new
Budget
appears in 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. void registerForChangedBudgets() throws OperationFailedException, PermissionDeniedException
BudgetReceiver.changedBudgets()
is invoked when a budget in
this business is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerFoChangedBudgetsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
BudgetReceiver.changedBudgets()
is invoked when a
budget in this business is changed.activityId
- the Id
of the Activity
to monitorNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerFoChangedBudgetsForFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
BudgetReceiver.changedBudgets()
is invoked when
a budget 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 registerForChangedBudget(Id budgetId) throws OperationFailedException, PermissionDeniedException
BudgetReceiver.changedBudgets()
is invoked when the specified
budget 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 registerForDeletedBudgets() throws OperationFailedException, PermissionDeniedException
BudgetReceiver.deletedBudgets()
is invoked when a budget is
deleted or removed from this business.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBudgetsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
BudgetReceiver.deletedBudgets()
is invoked when a
budget is deleted or removed from this business.activityId
- the Id
of the Activity
to monitorNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBudgetsForFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
BudgetReceiver.deletedBudgets()
is invoked when
a budget 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. void registerForDeletedBudget(Id budgetId) throws OperationFailedException, PermissionDeniedException
BudgetReceiver.deletedBudgets()
is invoked when the specified
budget 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.