OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.ProcedureNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Procedure objects. 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.

MethodgetCookbookId
Description

Gets the Cookbook Id associated with this session.

Returnosid.id.Idthe Cookbook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCookbook
Description

Gets the Cookbook associated with this session.

Returnosid.recipe.Cookbookthe cookbook
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForProcedureNotifications
Description

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

Federates the view for methods in this session. A federated view will include procedures in cook books which are children of this cook book in the cook book hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCookbookView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this cook book only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewProcedures
Description

Register for notifications of new procedures. ProcedureReceiver.newProcedures() is invoked when a new Procedure is created.

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

Registers for notification of updated procedures. ProcedureReceiver.changedProcedures() is invoked when a procedure is changed.

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

Registers for notification of an updated procedure. ProcedureReceiver.changedProcedures() is invoked when the specified procedure is changed.

Parametersosid.id.IdprocedureIdthe Id of the Procedure to monitor
ErrorsNULL_ARGUMENT procedureId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProcedures
Description

Registers for notification of deleted procedures. ProcedureReceiver.deletedProcedures() is invoked when a procedure is deleted.

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

Registers for notification of a deleted procedure. ProcedureReceiver.deletedProcedures() is invoked when the specified procedure is deleted.

Parametersosid.id.IdprocedureIdthe Id of the Procedure to monitor
ErrorsNULL_ARGUMENT procedureId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.