public interface CommitmentEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to CommitmentEnabler
objects in this Calendar.
This also includes existing CommitmentEnablers
that
may appear or disappear due to changes in the Calendar
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
CommitmentEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCommitmentEnablerNotification(Id notificationId)
Acknowledge a commitment enabler notification.
|
boolean |
canRegisterForCommitmentEnablerNotifications()
Tests if this user can register for
CommitmentEnabler
notifications. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
registerForChangedCommitmentEnabler(Id commitmentEnablerId)
Registers for notification of an updated commitment enabler.
|
void |
registerForChangedCommitmentEnablers()
Registers for notification of updated calendar enablers.
|
void |
registerForDeletedCommitmentEnabler(Id commitmentEnablerId)
Registers for notification of a deleted commitment enabler.
|
void |
registerForDeletedCommitmentEnablers()
Registers for notification of deleted commitment enablers.
|
void |
registerForNewCommitmentEnablers()
Register for notifications of new commitment enablers.
|
void |
reliableCommitmentEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableCommitmentEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForCommitmentEnablerNotifications()
CommitmentEnabler
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 useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. void reliableCommitmentEnablerNotifications()
acknowledgeCommitmentEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableCommitmentEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeCommitmentEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCommitmentEnablers() throws OperationFailedException, PermissionDeniedException
CommitmentEnablerReceiver.newCommitmentEnablers()
is invoked
when a new CommitmentEnabler
appears in this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommitmentEnablers() throws OperationFailedException, PermissionDeniedException
CommitmentEnablerReceiver.changedCommitmentEnablers()
is
invoked when a commitment enabler in this calendar is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommitmentEnabler(Id commitmentEnablerId) throws OperationFailedException, PermissionDeniedException
CommitmentEnablerReceiver.changedCommitmentEnablers()
is
invoked when the specified commitment enabler in this calendar is
changed.commitmentEnablerId
- the Id
of the
CommitmentEnabler
to monitorNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommitmentEnablers() throws OperationFailedException, PermissionDeniedException
CommitmentEnablerReceiver.deletedCommitmentEnablers()
is
invoked when a commitment enabler is deleted or removed from this
calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommitmentEnabler(Id commitmentEnablerId) throws OperationFailedException, PermissionDeniedException
CommitmentEnablerReceiver.deletedCommitmentEnablers()
is
invoked when the specified commitment enabler is deleted or removed
from this calendar.commitmentEnablerId
- the Id
of the
CommitmentEnabler
to monitorNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.