Interface | osid.personnel.OrganizationNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | getRealmId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Realm Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealm | ||
Description |
Gets the | ||
Return | osid.personnel.Realm | the realm | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForOrganizationNotifications | ||
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 | useFederatedRealmView | ||
Description |
Federates the view for methods in this session. A federated view will include notifications for organizations in realms which are children of this realm in the realm hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedRealmView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this realm only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewOrganizations | ||
Description |
Register for notifications of new organizations. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewOrganizationAncestors | ||
Description |
Registers for notification of an updated hierarchy
structure that introduces a new ancestor of the specified
organization. | ||
Parameters | osid.id.Id | organizationId | the Id of the Organization node to monitor |
Errors | NULL_ARGUMENT | organizationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewOrganizationDescendants | ||
Description |
Registers for notification of an updated hierarchy
structure that introduces a new descendant of the
specified organization. | ||
Parameters | osid.id.Id | organizationId | the Id of the Organization node to monitor |
Errors | NULL_ARGUMENT | organizationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOrganizations | ||
Description |
Registers for notification of updated organizations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOrganization | ||
Description |
Registers for notification of an updated organization.
| ||
Parameters | osid.id.Id | organizationId | the Id of the Organization to monitor |
Errors | NOT_FOUND | an organization was not found identified by the given Id | |
NULL_ARGUMENT | organizationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOrganizations | ||
Description |
Registers for notification of deleted organizations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOrganization | ||
Description |
Registers for notification of a deleted organization.
| ||
Parameters | osid.id.Id | organizationId | the Id of the Organization to monitor |
Errors | NOT_FOUND | an organization was not found identified by the given Id | |
NULL_ARGUMENT | organizationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOrganizationAncestors | ||
Description |
Registers for notification of an updated hierarchy
structure that removes an ancestor of the specified
organization. | ||
Parameters | osid.id.Id | organizationId | the Id of the Organization to monitor |
Errors | NULL_ARGUMENT | organizationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOrganizationDescendants | ||
Description |
Registers for notification of an updated hierarchy
structure that removes a descendant of the specified
organization. Organization | ||
Parameters | osid.id.Id | organizationId | the Id of the Organization to monitor |
Errors | NULL_ARGUMENT | organizationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |