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

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

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.
MethodcanRegisterForCommissionNotifications
Description

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

Register for notifications of new commissions. CommissionReceiver.newCommissions() is invoked when a new Commission appears in this foundry.

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

Register for notifications of new commissions for the given resource Id. CommissionReceiver.newCommissions() is invoked when a new Commission is created.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCommissionsForWork
Description

Register for notifications of new commissions for the given work Id. CommissionReceiver.newCommissions() is invoked when a new Commission is created.

Parametersosid.id.IdworkIdthe Id of the work to monitor
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCommissions
Description

Registers for notification of updated commissions. CommissionReceiver.changedCommissions() is invoked when a commission in this foundry is changed.

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

Register for notifications of updated commissions for the given resource Id. CommissionReceiver.changedCommissions() is invoked when a Commission in this foundry is changed.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCommissionsForWork
Description

Register for notifications of updated commissions for the given work Id. CommissionReceiver.changedCommissions() is invoked when a Commission in this foundry is changed.

Parametersosid.id.IdworkIdthe Id of the work to monitor
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCommission
Description

Registers for notification of an updated commission. CommissionReceiver.changedCommissions() is invoked when the specified commission in this foundry is changed.

Parametersosid.id.IdcommissionIdthe Id of the Commission to monitor
ErrorsNULL_ARGUMENT commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCommissions
Description

Registers for notification of deleted commissions. CommissionReceiver.deletedCommissions() is invoked when a commission is deleted or removed from this foundry.

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

Register for notifications of deleted commissions for the given resource Id. CommissionReceiver.deletedCommissions() is invoked when a Commission is deleted or removed from this foundry.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCommissionsForWork
Description

Register for notifications of deleted commissions for the given work Id. CommissionReceiver.deletedCommissions() is invoked when a Commission is deleted or removed from this foundry.

Parametersosid.id.IdworkIdthe Id of the work to monitor
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCommission
Description

Registers for notification of a deleted commission. CommissionReceiver.deletedCommissions() is invoked when the specified commission is deleted or removed from this foundry.

Parametersosid.id.IdcommissionIdthe Id of the Commission to monitor
ErrorsNULL_ARGUMENT commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.