Package step.repository.alm.otaclient

Interface IAlertManager

  • All Superinterfaces:
    com4j.Com4jObject
    All Known Subinterfaces:
    IAlertManager2
    public interface IAlertManager
extends com4j.Com4jObject
    Services for managing alerts.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com4j.Com4jObject alert​(int id)
      Gets the Alert object for the alert with the specified ID.
      IList alertList​(java.lang.String entityType, boolean needRefresh)
      The list of user alerts.
      void cleanAllAlerts()
      Removes all current alerts from the database.
      void deleteAlert​(java.lang.Object iDs)
      Removes an alert or alerts related to the current object from the database.

      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

    • Method Detail

      • deleteAlert

        void deleteAlert​(java.lang.Object iDs)

        Removes an alert or alerts related to the current object from the database.

        Parameters:
        iDs - Mandatory java.lang.Object parameter.

      • cleanAllAlerts

        void cleanAllAlerts()

        Removes all current alerts from the database.

      • alert

        com4j.Com4jObject alert​(int id)

        Gets the Alert object for the alert with the specified ID.

        Getter method for the COM property "Alert"

        Parameters:
        id - Mandatory int parameter.
        Returns:
        Returns a value of type com4j.Com4jObject

      • alertList

        IList alertList​(java.lang.String entityType,
                @DefaultValue("0")
                boolean needRefresh)

        The list of user alerts.

        Getter method for the COM property "AlertList"

        Parameters:
        entityType - Mandatory java.lang.String parameter.
        needRefresh - Optional parameter. Default value is false
        Returns:
        Returns a value of type otaclient.IList