Package step.repository.alm.v16.otaclient

Interface IAlert

  • All Superinterfaces:
    com4j.Com4jObject
    public interface IAlert
extends com4j.Com4jObject
    Represents a notification sent to the user.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Date alertDate()
      The date that the alert was generated, based on the database server clock.
      int alertType()
      The type of alert generated: Alert or Follow-up.
      java.lang.String description()
      The description of the alert.
      int id()
      The alert or follow-up ID.
      java.lang.String parentEntityURL()
      For HP use.
      java.lang.String subject()
      A short summary appropriate to be used as subject line of the Alert e-mail.
      boolean unread()
      If true, the alert or follow-up has not yet been read.
      void unread​(boolean pVal)
      If true, the alert or follow-up has not yet been read.

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • description

        java.lang.String description()

        The description of the alert.

        Getter method for the COM property "Description"

        Returns:
        Returns a value of type java.lang.String

      • alertDate

        java.util.Date alertDate()

        The date that the alert was generated, based on the database server clock.

        Getter method for the COM property "AlertDate"

        Returns:
        Returns a value of type java.util.Date

      • id

        int id()

        The alert or follow-up ID.

        Getter method for the COM property "ID"

        Returns:
        Returns a value of type int

      • alertType

        int alertType()

        The type of alert generated: Alert or Follow-up.

        Getter method for the COM property "AlertType"

        Returns:
        Returns a value of type int

      • unread

        boolean unread()

        If true, the alert or follow-up has not yet been read.

        Getter method for the COM property "Unread"

        Returns:
        Returns a value of type boolean

      • unread

        void unread​(boolean pVal)

        If true, the alert or follow-up has not yet been read.

        Setter method for the COM property "Unread"

        Parameters:
        pVal - Mandatory boolean parameter.

      • subject

        java.lang.String subject()

        A short summary appropriate to be used as subject line of the Alert e-mail.

        Getter method for the COM property "Subject"

        Returns:
        Returns a value of type java.lang.String

      • parentEntityURL

        java.lang.String parentEntityURL()

        For HP use. The location of the parent object to which the alert or follow-up is related.

        Getter method for the COM property "ParentEntityURL"

        Returns:
        Returns a value of type java.lang.String