OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.OrganizationNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Organization objects. 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.

MethodgetRealmId
Description

Gets the Realm Id associated with this session.

Returnosid.id.Idthe Realm Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRealm
Description

Gets the Realm associated with this session.

Returnosid.personnel.Realmthe realm
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForOrganizationNotifications
Description

Tests if this user can register for Organization 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.
MethoduseFederatedRealmView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRealmView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this realm only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewOrganizations
Description

Register for notifications of new organizations. OrganizationReceiver.newOrganizations() is invoked when a new Organization is created.

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

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified organization. OrganizationReceiver.newAncestorOrganization() is invoked when the specified organization node gets a new ancestor.

Parametersosid.id.IdorganizationIdthe Id of the Organization node to monitor
ErrorsNULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewOrganizationDescendants
Description

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified organization. OrganizationReceiver.newDescendantOrganization() is invoked when the specified organization node gets a new descendant.

Parametersosid.id.IdorganizationIdthe Id of the Organization node to monitor
ErrorsNULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOrganizations
Description

Registers for notification of updated organizations. OrganizationReceiver.changedOrganizations() is invoked when an organization in this realm is changed.

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

Registers for notification of an updated organization. OrganizationReceiver.changedOrganizations() is invoked when the specified organization in this realm is changed.

Parametersosid.id.IdorganizationIdthe Id of the Organization to monitor
ErrorsNOT_FOUNDan organization was not found identified by the given Id
NULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOrganizations
Description

Registers for notification of deleted organizations. OrganizationReceiver.deletedOrganizations() is invoked when an organization is removed from this realm.

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

Registers for notification of a deleted organization. OrganizationReceiver.deletedOrganizations() is invoked when the specified organization is removed from this realm.

Parametersosid.id.IdorganizationIdthe Id of the Organization to monitor
ErrorsNOT_FOUNDan organization was not found identified by the given Id
NULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOrganizationAncestors
Description

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified organization. OrganizationReceiver.deletedAncestorOrganization() is invoked when the specified organization node loses an ancestor.

Parametersosid.id.IdorganizationIdthe Id of the Organization to monitor
ErrorsNULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOrganizationDescendants
Description

Registers for notification of an updated hierarchy structure that removes a descendant of the specified organization. Organization Receiver.deletedDescendantOrganization() is invoked when the specified organization node loses a descendant.

Parametersosid.id.IdorganizationIdthe Id of the Organization to monitor
ErrorsNULL_ARGUMENT organizationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.