org.osid.resourcing

Interface JobNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getFoundryId

Id getFoundryId()

Gets the Foundry Id associated with this session.

Returns:

the Foundry Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFoundry

Foundry getFoundry()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Foundry associated with this session.

Returns:

the foundry

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForJobNotifications

boolean canRegisterForJobNotifications()

Tests if this user can register for 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedFoundryView

void useFederatedFoundryView()

Federates the view for methods in this session. A federated view will include jobs in foundries which are children of this foundry in the foundry hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFoundryView

void useIsolatedFoundryView()

Isolates the view for methods in this session. An isolated view restricts notifications to this foundry only.

Compliance:

mandatory - This method is must be implemented.

registerForNewJobs

void registerForNewJobs()
                        throws OperationFailedException,
                               PermissionDeniedException

Register for notifications of new jobs. JobReceiver.newJobs() is invoked when a new Job appears in this foundry.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJobs

void registerForChangedJobs()
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of updated jobs. JobReceiver.changedJobs() is invoked when a job in this foundry is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJob

void registerForChangedJob(Id jobId)
                           throws OperationFailedException,
                                  PermissionDeniedException

Registers for notification of an updated job. JobReceiver.changedJobs() is invoked when the specified job in this foundry is changed.

Parameters:

jobId - the Id of the Job to monitor

Throws:

NullArgumentException - jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedJobs

void registerForDeletedJobs()
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of deleted jobs. JobReceiver.deletedJobs() is invoked when a job is deleted or removed from this foundry.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedJob

void registerForDeletedJob(Id jobId)
                           throws OperationFailedException,
                                  PermissionDeniedException

Registers for notification of a deleted job. JobReceiver.deletedJobs() is invoked when the specified job is deleted or removed from this foundry.

Parameters:

jobId - the Id of the Job to monitor

Throws:

NullArgumentException - jobId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.