Interface ProfileEntryEnablerNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ProfileEntryEnablerNotificationSession extends OsidSession

This session defines methods to receive notifications on adds/changes to ProfileEntryEnabler objects in this Profile . This also includes existing ProfileEntryEnablers that may appear or disappear due to changes in the Profile 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 ProfileEntryEnablerLookupSession .

  • Method Details

    • getProfileId

      Id getProfileId()
      Gets the Profile Id associated with this session.
      Returns:
      the Profile Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getProfile

      Profile getProfile() throws OperationFailedException, PermissionDeniedException
      Gets the Profile associated with this session.
      Returns:
      the profile
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForProfileEntryEnablerNotifications

      boolean canRegisterForProfileEntryEnablerNotifications()
      Tests if this user can register for ProfileEntryEnabler 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.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedProfileView

      void useFederatedProfileView()
      Federates the view for methods in this session. A federated view will include enablers in profiles which are children of this profile in the profile hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedProfileView

      void useIsolatedProfileView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this profile only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableProfileEntryEnablerNotifications

      void reliableProfileEntryEnablerNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeProfileEntryEnablerNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableProfileEntryEnablerNotifications

      void unreliableProfileEntryEnablerNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeProfileEntryEnablerNotification

      void acknowledgeProfileEntryEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a profile entry enabler notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewProfileEntryEnablers

      void registerForNewProfileEntryEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new profile entry enablers. ProfileEntryEnablerReceiver.newProfileEntryEnablers() is invoked when a new ProfileEntryEnabler appears in this profile.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProfileEntryEnablers

      void registerForChangedProfileEntryEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated profile enabelrs. ProfileEntryEnablerReceiver.changedProfileEntryEnablers() is invoked when a profile entry enabler in this profile is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedProfileEntryEnabler

      void registerForChangedProfileEntryEnabler(Id profileEntryEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated profile entry enabler. ProvisionableReceiver.changedProfileEntryEnablers() is invoked when the specified profile entry enabler in this profile is changed.
      Parameters:
      profileEntryEnablerId - the Id of the ProfileEntryEnabler to monitor
      Throws:
      NullArgumentException - profileEntryEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProfileEntryEnablers

      void registerForDeletedProfileEntryEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted profile entry enablers. ProfileEntryEnablerReceiver.deletedProfileEntryEnablers() is invoked when a profile entry enabler is deleted or removed from this profile.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedProfileEntryEnabler

      void registerForDeletedProfileEntryEnabler(Id profileEntryEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted profile entry enabler. ProfileEntryEnablerReceiver.deletedProfileEntryEnablers() is invoked when the specified profile entry enabler is deleted or removed from this profile.
      Parameters:
      profileEntryEnablerId - the Id of the ProfileEntryEnabler to monitor
      Throws:
      NullArgumentException - profileEntryEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.