public interface JobNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Job
objects in this Foundry.
This also
includes existing jobs 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
JobLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForJobNotifications()
Tests if this user can register for
Job notifications. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
registerForChangedJob(Id jobId)
Registers for notification of an updated job.
|
void |
registerForChangedJobs()
Registers for notification of updated jobs.
|
void |
registerForDeletedJob(Id jobId)
Registers for notification of a deleted job.
|
void |
registerForDeletedJobs()
Registers for notification of deleted jobs.
|
void |
registerForNewJobs()
Register for notifications of new jobs.
|
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 canRegisterForJobNotifications()
Job
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 registerForNewJobs() throws OperationFailedException, PermissionDeniedException
JobReceiver.newJobs()
is invoked when a new Job
appears in this
foundry.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedJobs() throws OperationFailedException, PermissionDeniedException
JobReceiver.changedJobs()
is invoked when a job in this
foundry is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedJob(Id jobId) throws OperationFailedException, PermissionDeniedException
JobReceiver.changedJobs()
is invoked when the specified job in
this foundry is changed.jobId
- the Id
of the Job
to
monitorNullArgumentException
- jobId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedJobs() throws OperationFailedException, PermissionDeniedException
JobReceiver.deletedJobs()
is invoked when a job is deleted or
removed from this foundry.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedJob(Id jobId) throws OperationFailedException, PermissionDeniedException
JobReceiver.deletedJobs()
is invoked when the specified job is
deleted or removed from this foundry.jobId
- the Id
of the Job
to
monitorNullArgumentException
- jobId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.