org.osid.resourcing.rules

Interface JobConstrainerEnablerNotificationSession

All Superinterfaces:

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

public interface JobConstrainerEnablerNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to JobConstrainerEnabler objects in this Foundry. This also includes existing JobConstrainerEnablers 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 JobConstrainerEnablerLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForJobConstrainerEnablerNotifications() Tests if this user can register for JobConstrainerEnabler notifications.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
void	registerForChangedJobConstrainerEnabler(Id jobConstrainerEnablerId) Registers for notification of an updated job constrainer enabler.
void	registerForChangedJobConstrainerEnablers() Registers for notification of updated foundry enabelrs.
void	registerForDeletedJobConstrainerEnabler(Id jobConstrainerEnablerId) Registers for notification of a deleted job constrainer enabler.
void	registerForDeletedJobConstrainerEnablers() Registers for notification of deleted job constrainer enablers.
void	registerForNewJobConstrainerEnablers() Register for notifications of new job constrainer enablers.
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.

canRegisterForJobConstrainerEnablerNotifications

boolean canRegisterForJobConstrainerEnablerNotifications()

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

registerForNewJobConstrainerEnablers

void registerForNewJobConstrainerEnablers()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of new job constrainer enablers. JobConstrainerEnablerReceiver.newJobConstrainerEnabler() is invoked when a new JobConstrainerEnabler appears in this foundry.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJobConstrainerEnablers

void registerForChangedJobConstrainerEnablers()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of updated foundry enabelrs. JobConstrainerEnablerReceiver.changedJobConstrainerEnabler() is invoked when a job constrainer enabler in this foundry is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJobConstrainerEnabler

void registerForChangedJobConstrainerEnabler(Id jobConstrainerEnablerId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of an updated job constrainer enabler. ProvisionableReceiver.changedJobConstrainerEnabler() is invoked when the specified job constrainer enabler in this foundry is changed.

Parameters:

jobConstrainerEnablerId - the Id of the JobConstrainerEnabler to monitor

Throws:

NullArgumentException - jobConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedJobConstrainerEnablers

void registerForDeletedJobConstrainerEnablers()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification of deleted job constrainer enablers. JobConstrainerEnablerReceiver.deletedJobConstrainerEnabler() is invoked when a job constrainer enabler is deleted or removed from this foundry.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedJobConstrainerEnabler

void registerForDeletedJobConstrainerEnabler(Id jobConstrainerEnablerId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of a deleted job constrainer enabler. JobConstrainerEnablerReceiver.deletedJobConstrainerEnabler() is invoked when the specified job constrainer enabler is deleted or removed from this foundry.

Parameters:

jobConstrainerEnablerId - the Id of the JobConstrainerEnabler to monitor

Throws:

NullArgumentException - jobConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.