Interface | osid.resource.demographic.DemographicEnablerNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getBinId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bin Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBin | ||
Description |
Gets the | ||
Return | osid.resource.Bin | the bin | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForDemographicEnablerNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedBinView | ||
Description |
Federates the view for methods in this session. A federated view will include enablers in bins which are children of this bin in the bin hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBinView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this bin only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewDemographicEnablers | ||
Description |
Register for notifications of new demographic enablers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedDemographicEnablers | ||
Description |
Registers for notification of updated bin enabelrs.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedDemographicEnabler | ||
Description |
Registers for notification of an updated demographic
enabler. | ||
Parameters | osid.id.Id | demographicEnablerProcessorId | the Id of the DemographicEnabler to monitor |
Errors | NULL_ARGUMENT | demographicEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedDemographicEnablers | ||
Description |
Registers for notification of deleted demographic
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedDemographicEnabler | ||
Description |
Registers for notification of a deleted demographic
enabler. | ||
Parameters | osid.id.Id | demographicEnablerId | the Id of the DemographicEnabler to monitor |
Errors | NULL_ARGUMENT | demographicEnablerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |