public interface CompetencyNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Competency
objects in this Foundry.
This
also includes existing competencies that may appear or disappear due to
changes in the Foundry
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
CompetencyLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForCompetencyNotifications()
Tests if this user can register for
Competency
notifications. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
registerForChangedCompetencies()
Registers for notification of updated competencies.
|
void |
registerForChangedCompetency(Id competencyId)
Registers for notification of an updated competency.
|
void |
registerForDeletedCompetencies()
Registers for notification of deleted competencies.
|
void |
registerForDeletedCompetency(Id competencyId)
Registers for notification of a deleted competency.
|
void |
registerForNewCompetencies()
Register for notifications of new competencies.
|
void |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForCompetencyNotifications()
Competency
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 useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. void registerForNewCompetencies() throws OperationFailedException, PermissionDeniedException
CompetencyReceiver.newCompetencies()
is invoked when a new
Competency
appears in this foundry.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCompetencies() throws OperationFailedException, PermissionDeniedException
CompetencyReceiver.changedCompetencies()
is invoked when a
competency in this foundry is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCompetency(Id competencyId) throws OperationFailedException, PermissionDeniedException
AvailabilityReceiver.changedCompetencies()
is invoked when the
specified competency in this foundry is changed.competencyId
- the Id
of the Competency
to monitorNullArgumentException
- competencyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCompetencies() throws OperationFailedException, PermissionDeniedException
CompetencyReceiver.deletedCompetencies()
is invoked when a
competency is deleted or removed from this foundry.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCompetency(Id competencyId) throws OperationFailedException, PermissionDeniedException
CompetencyReceiver.deletedCompetencies()
is invoked when the
specified competency is deleted or removed from this foundry.competencyId
- the Id
of the Competency
to monitorNullArgumentException
- competencyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.