Package step.repository.alm.v16.otaclient

Interface IExecEventNotifyByMailSettings

  • All Superinterfaces:
    com4j.Com4jObject
    All Known Subinterfaces:
    IExecEventNotifyByMailSettings2
    public interface IExecEventNotifyByMailSettings
extends com4j.Com4jObject
    Represents the notification to be sent by e-mail after a test has completed its run.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String eMailTo()
      The recipients' e-mail addresses.
      void eMailTo​(java.lang.String pVal)
      The recipients' e-mail addresses.
      boolean enabled​(int eventType)
      Indicates if mail is enabled for the specified event type.
      void enabled​(int eventType, boolean pVal)
      Indicates if mail is enabled for the specified event type.
      void save​(boolean autoPost)
      Uploads the notification settings to the server.
      java.lang.String userMessage()
      The message body of the e-mail.
      void userMessage​(java.lang.String pVal)
      The message body of the e-mail.

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • eMailTo

        java.lang.String eMailTo()

        The recipients' e-mail addresses.

        Getter method for the COM property "EMailTo"

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

      • eMailTo

        void eMailTo​(java.lang.String pVal)

        The recipients' e-mail addresses.

        Setter method for the COM property "EMailTo"

        Parameters:
        pVal - Mandatory java.lang.String parameter.

      • userMessage

        java.lang.String userMessage()

        The message body of the e-mail.

        Getter method for the COM property "UserMessage"

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

      • userMessage

        void userMessage​(java.lang.String pVal)

        The message body of the e-mail.

        Setter method for the COM property "UserMessage"

        Parameters:
        pVal - Mandatory java.lang.String parameter.

      • enabled

        boolean enabled​(int eventType)

        Indicates if mail is enabled for the specified event type.

        Getter method for the COM property "Enabled"

        Parameters:
        eventType - Mandatory int parameter.
        Returns:
        Returns a value of type boolean

      • enabled

        void enabled​(int eventType,
             boolean pVal)

        Indicates if mail is enabled for the specified event type.

        Setter method for the COM property "Enabled"

        Parameters:
        eventType - Mandatory int parameter.
        pVal - Mandatory boolean parameter.

      • save

        void save​(@DefaultValue("-1")
          boolean autoPost)

        Uploads the notification settings to the server.

        Parameters:
        autoPost - Optional parameter. Default value is false