OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.JobProcessorNotificationSession
Implementsosid.OsidSession
Description

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

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForJobProcessorNotifications
Description

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

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedFoundryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFoundryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewJobProcessors
Description

Register for notifications of new job processors. JobProcessorReceiver.newJobProcessors() is invoked when a new JobProcessor appears in this foundry.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedJobProcessors
Description

Registers for notification of updated foundries. JobProcessorReceiver.changedJobProcessors() is invoked when a job processor in this foundry is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedJobProcessor
Description

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

Parametersosid.id.IdjobProcessorIdthe Id of the JobProcessor to monitor
ErrorsNULL_ARGUMENT jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedJobProcessors
Description

Registers for notification of deleted job processors. JobProcessorReceiver.deletedJobProcessors() is invoked when a job processor is deleted or removed from this foundry.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedJobProcessor
Description

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

Parametersosid.id.IdjobProcessorIdthe Id of the JobProcessor to monitor
ErrorsNULL_ARGUMENT jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.