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

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

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

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

Register for notifications of new efforts. EffortReceiver.newEfforts() is invoked when a new Effort appears in this foundry.

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

Register for notifications of new efforts for the given resource Id. EffortReceiver.newEfforts() is invoked when a new Effort 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.
MethodregisterForNewEffortsForCommission
Description

Register for notifications of new efforts for the given commission Id. EffortReceiver.newEfforts() is invoked when a new Effort is created.

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

Register for notifications of new efforts for the given work Id. EffortReceiver.newEfforts() is invoked when a new Effort 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.
MethodregisterForChangedEfforts
Description

Registers for notification of updated efforts. EffortReceiver.changedEfforts() is invoked when an effort in this foundry is changed.

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

Register for notifications of updated efforts for the given resource Id. EffortReceiver.changedEfforts() is invoked when an effort 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.
MethodregisterForChangedEffortsForCommission
Description

Register for notifications of updated efforts for the given commission Id. EffortReceiver.changedEfforts() is invoked when an effort 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.
MethodregisterForChangedEffortsForWork
Description

Register for notifications of updated efforts for the given work Id. EffortReceiver.changedEfforst() is invoked when an effort 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.
MethodregisterForChangedEffort
Description

Registers for notification of an updated effort. EffortReceiver.changedEfforts() is invoked when the specified effort in this foundry is changed.

Parametersosid.id.IdeffortIdthe Id of the Effort to monitor
ErrorsNULL_ARGUMENT effortId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEfforts
Description

Registers for notification of deleted efforts. EffortReceiver.deletedEfforts() is invoked when an effort is deleted or removed from this foundry.

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

Register for notifications of deleted efforts for the given resource Id. EffortReceiver.deletedEfforts() is invoked when an effort in this foundry is removed or deleted.

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

Register for notifications of deleted efforts for the given commission Id. EffortReceiver.deletedEfforts() is invoked when an effort in this foundry is removed or deleted.

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

Register for notifications of deleted efforts for the given work Id. EffortReceiver.deletedEfforts() is invoked when an effort in this foundry is removed or deleted.

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

Registers for notification of a deleted effort. EffortReceiver.deletedEfforts() is invoked when the specified effort is deleted or removed from this foundry.

Parametersosid.id.IdeffortIdthe Id of the Effort to monitor
ErrorsNULL_ARGUMENT effortId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.