public interface CommitmentNotificationSession extends OsidSession
This session defines methods to receive asynchronous notifications on adds/changes to event commitments. 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 views defined in this session correspond to the views in the
CommitmentLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCommitmentNotification(Id notificationId)
Acknowledge a commitment notification.
|
boolean |
canRegisterForCommitmentNotifications()
Tests if this user can register for
Commitment
notifications. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
registerForChangedCommitment(Id commitmentId)
Registers for notification of an updated commitment.
|
void |
registerForChangedCommitments()
Registers for notification of updated commitments.
|
void |
registerForChangedCommitmentsByGenusType(Type commitmentGenusType)
Register for notifications of changed commitments by commitment genus
type.
|
void |
registerForChangedCommitmentsForEvent(Id eventId)
Register for notifications of changed commitments for the given event.
|
void |
registerForChangedCommitmentsForResource(Id resourceId)
Register for notifications of changed commitments for the given
rsource.
|
void |
registerForDeletedCommitment(Id commitmentId)
Registers for notification of a deleted commitment.
|
void |
registerForDeletedCommitments()
Registers for notification of deleted commitments.
|
void |
registerForDeletedCommitmentsByGenusType(Id commitmentGenusType)
Register for notifications of deleted commitments by commitment genus
type.
|
void |
registerForDeletedCommitmentsForEvent(Id eventId)
Register for notifications of deleted commitments for the given event.
|
void |
registerForDeletedCommitmentsForResource(Id resourceId)
Register for notifications of deleted commitments for the given
rsource.
|
void |
registerForNewCommitments()
Register for notifications of new commitments.
|
void |
registerForNewCommitmentsByGenusType(Id commitmentGenusType)
Register for notifications of new commitments by commitment genus
type.
|
void |
registerForNewCommitmentsForEvent(Id eventId)
Register for notifications of new commitments for the given event.
|
void |
registerForNewCommitmentsForResource(Id resourceId)
Register for notifications of new commitments for the given resource.
|
void |
reliableCommitmentNotifications()
Reliable notifications are desired.
|
void |
unreliableCommitmentNotifications()
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. Calendar
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForCommitmentNotifications()
Commitment
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 reliableCommitmentNotifications()
acknowledgeCommitmentNotification()
.mandatory
- This method is must be implemented. void unreliableCommitmentNotifications()
mandatory
- This method is must be implemented. void acknowledgeCommitmentNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCommitments() throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.newCommitments()
is invoked when a new
commitment is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCommitmentsByGenusType(Id commitmentGenusType) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.newCommitments()
is invoked
when a new commitment is created.commitmentGenusType
- the commitment genus type to monitorNullArgumentException
- commitmentGenusType is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCommitmentsForEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.newCommitments()
is invoked when a
new commitment is created.eventId
- the Id
of the Event
to
monitorNullArgumentException
- eventId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCommitmentsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.newCommitments()
is invoked when a
new commitment is created.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommitments() throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.changedCommitments()
is invoked when a
commitment is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommitmentsByGenusType(Type commitmentGenusType) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.changedCommitments()
is
invoked when a commitment is changed.commitmentGenusType
- the commitment genus type to monitorNullArgumentException
- commitmentGenusType is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommitmentsForEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.changedCommitments()
is invoked when
a commitment is changed.eventId
- the Id
of the Event
to
monitorNullArgumentException
- eventId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommitmentsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.changedCommitments()
is
invoked when a commitment is changed.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCommitment(Id commitmentId) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.changedCommitments()
is invoked when the
specified commitment is changed.commitmentId
- the Id
of the Commitment
to monitorNullArgumentException
- commitmentId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommitments() throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.deletedCommitments()
is invoked when a
commitment is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommitmentsByGenusType(Id commitmentGenusType) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.deletedCommitments()
is
invoked when a commitment is deleted.commitmentGenusType
- the commitment genus type to monitorNullArgumentException
- commitmentGenusType is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommitmentsForEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.deletedCommitments()
is invoked when
a commitment is deleted.eventId
- the Id
of the Event
to
monitorNullArgumentException
- eventId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommitmentsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.deletedCommitments()
is
invoked when a commitment is deleted.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCommitment(Id commitmentId) throws OperationFailedException, PermissionDeniedException
CommitmentReceiver.changedCommitments()
is invoked when the
specified commitment is deleted.commitmentId
- the Id
of the Commitment
to monitorNullArgumentException
- commitmentId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.