Interface | osid.authentication.AgentNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getAgencyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Agency Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgency | ||
Description |
Gets the | ||
Return | osid.authentication.Agency | the Agency associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForAgentNotifications | ||
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 | useFederatedAgencyView | ||
Description |
Federates the view for methods in this session. A federated view will include agents in agencies which are children of this agency in the agency hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedAgencyView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this agency only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableAgentNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableAgentNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeAgentNotification | ||
Description |
Acknowledge an agent notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAgents | ||
Description |
Register for notifications of new agents. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAgents | ||
Description |
Registers for notification of updated agents. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAgent | ||
Description |
Registers for notification of an updated agent. | ||
Parameters | osid.id.Id | agentId | the Id of the Agent to monitor |
Errors | NULL_ARGUMENT | agentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAgents | ||
Description |
Registers for notification of deleted agents. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAgent | ||
Description |
Registers for notification of a deleted agent. | ||
Parameters | osid.id.Id | agentId | the Id of the Agent to monitor |
Errors | NULL_ARGUMENT | agentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |