Class PopupExpression


  • public final class PopupExpression
    extends java.lang.Object
    Defines an Arcade expression within a pop-up.
    Since:
    100.3.0
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PopupExpression.ReturnType
      The type of the result returned by an Arcade expression.
    • Constructor Summary

      Constructors 
      Constructor Description
      PopupExpression()
      Creates a new instance of an empty PopupExpression.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getExpression()
      Gets the Arcade expression defined in this expression.
      java.lang.String getName()
      Gets the name of this expression.
      PopupExpression.ReturnType getReturnType()
      Gets the return type of this expression.
      java.lang.String getTitle()
      Gets the title of this expression.
      void setExpression​(java.lang.String expression)
      Sets the Arcade expression defined in this expression.
      void setName​(java.lang.String name)
      Sets the name of this expression.
      void setReturnType​(PopupExpression.ReturnType returnType)
      Sets the return type of this expression.
      void setTitle​(java.lang.String title)
      Sets the title of this expression.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • PopupExpression

        public PopupExpression()
        Creates a new instance of an empty PopupExpression.

        Use a pop-up expression object to define an Arcade expression within a pop-up.

        Since:
        100.5.0
    • Method Detail

      • getExpression

        public java.lang.String getExpression()
        Gets the Arcade expression defined in this expression.
        Returns:
        an Arcade expression string
        Since:
        100.3.0
      • setExpression

        public void setExpression​(java.lang.String expression)
        Sets the Arcade expression defined in this expression.
        Parameters:
        expression - the Arcade expression string
        Since:
        100.3.0
      • getName

        public java.lang.String getName()
        Gets the name of this expression.
        Returns:
        the name of this expression
        Since:
        100.3.0
      • setName

        public void setName​(java.lang.String name)
        Sets the name of this expression.
        Parameters:
        name - the name of this expression
        Since:
        100.3.0
      • getTitle

        public java.lang.String getTitle()
        Gets the title of this expression.
        Returns:
        the title of this expression
        Since:
        100.3.0
      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title of this expression.
        Parameters:
        title - the title of this expression
        Since:
        100.3.0
      • getReturnType

        public PopupExpression.ReturnType getReturnType()
        Gets the return type of this expression.
        Returns:
        the return type of this expression
        Since:
        100.3.0
      • setReturnType

        public void setReturnType​(PopupExpression.ReturnType returnType)
        Sets the return type of this expression.
        Parameters:
        returnType - the return type of this expression
        Throws:
        java.lang.IllegalArgumentException - if returnType is null
        Since:
        100.3.0