Package com.appiancorp.suiteapi.web.portal

Class PortalStateTag

java.lang.Object
javax.servlet.jsp.tagext.TagSupport
com.appiancorp.suiteapi.web.portal.PortalStateTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
public class PortalStateTag extends javax.servlet.jsp.tagext.TagSupport implements javax.servlet.jsp.tagext.Tag
Implementation for the portalState tag, which provides access to a PortalState object initialized from the current HttpServletRequest.
See Also:

  • Field Summary

    Fields inherited from class javax.servlet.jsp.tagext.TagSupport

    id, pageContext

    Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

    EVAL_BODY_AGAIN

    Fields inherited from interface javax.servlet.jsp.tagext.Tag

    EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

  • Constructor Summary

    Constructors
    Constructor
    Description
    PortalStateTag()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doEndTag()
     
    int
    doStartTag()
     
    String
    getScope()
    Get the scope in which the variable will be created.
    String
    getVar()
    Get the name of the variable that this tag will create.
    void
    setScope(String p)
    Set the scope in which the variable will be created.
    void
    setVar(String p)
    Set the name of the variable that this tag will create.

    Methods inherited from class javax.servlet.jsp.tagext.TagSupport

    doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface javax.servlet.jsp.tagext.Tag

    getParent, release, setPageContext, setParent

  • Constructor Details

    • PortalStateTag

      public PortalStateTag()

  • Method Details

    • getVar

      public String getVar()
      Get the name of the variable that this tag will create.
      Returns:
      The name.

    • setVar

      public void setVar(String p)
      Set the name of the variable that this tag will create.
      Parameters:
      p - The name.

    • getScope

      public String getScope()
      Get the scope in which the variable will be created.
      Returns:
      The name of the scope.

    • setScope

      public void setScope(String p)
      Set the scope in which the variable will be created. The default is "page".
      Parameters:
      p - The name of the scope. One of "page", "request", "session", or "application".

    • doStartTag

      public int doStartTag() throws javax.servlet.jsp.JspException
      Specified by:
      doStartTag in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class javax.servlet.jsp.tagext.TagSupport
      Throws:
      javax.servlet.jsp.JspException

    • doEndTag

      public int doEndTag() throws javax.servlet.jsp.JspException
      Specified by:
      doEndTag in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class javax.servlet.jsp.tagext.TagSupport
      Throws:
      javax.servlet.jsp.JspException