Interface FiscalPeriodNotificationSession

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

This session defines methods to receive notifications on adds/changes to FiscalPeriods . in this Business . This also includes existing fiscal periods that may appear or disappear due to changes in the Business 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 FiscalPeriodLookupSession .

  • Method Details

    • getBusinessId

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

    • getBusiness

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

    • canRegisterForFiscalPeriodNotifications

      boolean canRegisterForFiscalPeriodNotifications()
      Tests if this user can register for FiscalPeriod 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.

    • useFederatedBusinessView

      void useFederatedBusinessView()
      Federates the view for methods in this session. A federated view will include fiscal periods in catalogs which are children of this catalog in the business hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBusinessView

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

    • reliableFiscalPeriodNotifications

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

    • unreliableFiscalPeriodNotifications

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

    • acknowledgeFiscalPeriodNotification

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

    • registerForNewFiscalPeriods

      void registerForNewFiscalPeriods() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new fiscal periods. FiscalPeriodReceiver.newFiscalPeriods() is invoked when a new FiscalPeriod appears in this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedFiscalPeriods

      void registerForChangedFiscalPeriods() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated fiscal periods. FiscalPeriodReceiver.changedFiscalPeriods() is invoked when a fiscal period in this business is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedFiscalPeriod

      void registerForChangedFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated fiscal period. FiscalPeriodReceiver.changedFiscalPeriods() is invoked when the specified fiscal period in this business is changed.
      Parameters:
      fiscalPeriodId - the Id of the FiscalPeriod to monitor
      Throws:
      NullArgumentException - fiscalPeriodId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedFiscalPeriods

      void registerForDeletedFiscalPeriods() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted fiscal periods. FiscalPeriodReceiver.deletedFiscalPeriods() is invoked when a fiscal period is deleted or removed from this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedFiscalPeriod

      void registerForDeletedFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted fiscal period. FiscalPeriodReceiver.deletedFiscalPeriods() is invoked when the specified fiscal period is deleted or removed from this business.
      Parameters:
      fiscalPeriodId - the Id of the FiscalPeriod to monitor
      Throws:
      NullArgumentException - fiscalPeriodId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.