Package com.microstrategy.web.objects

Interface WebToken

  • public interface WebToken
    This interface represents a token.
    Since:
    MicroStrategy Web 9.2.2

    • Method Detail

      • getValue

        java.lang.String getValue()
        Get the value of the token.
        Returns:
        value

      • setValue

        void setValue​(java.lang.String value)
        Set the value of the token.
        Parameters:
        value -

      • getType

        int getType()
        Get the token type.
        Returns:
        token type from EnumDSSXMLTokenTypes

      • setType

        void setType​(int type)
        Set the token type.
        Parameters:
        type - form EnumDSSXMLTokenTypes

      • getObject

        WebObjectInfo getObject()
        Get the object referred by this token.
        Returns:
        DSS object

      • setObject

        void setObject​(WebObjectInfo obj)
        Set the object referred by this token.
        Parameters:
        obj -

      • getLevel

        int getLevel()
        Get the level of the token.
        Returns:
        level from EnumDSSXMLTokenLevels

      • setLevel

        void setLevel​(int level)
        Set the level of the token.
        Parameters:
        level - from EnumDSSXMLTokenLevels

      • getState

        int getState()
        Get the state of the token.
        Returns:
        state from EnumDSSXMLTokenStates

      • setState

        void setState​(int state)
        Set the state of the token.
        Parameters:
        state - from EnumDSSXMLTokenStates

      • getExtraValueType

        java.lang.String getExtraValueType()
        Get the extra value type information for the referred object.
        Returns:
        extra value type information for the referred object

      • setExtraValueType

        void setExtraValueType​(java.lang.String vtp)
        Set the extra value type information for the referred object.
        Parameters:
        vtp - extra value type information for the referred object

      • getExtraValue

        java.lang.String getExtraValue()
        Get the extra value information for the referred object.
        Returns:
        extra value information for the referred object

      • setExtraValue

        void setExtraValue​(java.lang.String v)
        Set the extra value information for the referred object.
        Parameters:
        v - extra value information for the referred object

      • setSectionType

        void setSectionType​(int sectionType)
        Set the token section type.
        Parameters:
        token - section type form EnumDSSXMLTokenSectionTypes

      • getSectionType

        int getSectionType()
        Get the token section type.
        Returns:
        token section type form EnumDSSXMLTokenSectionTypes

      • getElements

        WebElements getElements()
        Get Token Elements.
        Returns:
        Token Elements

      • setElements

        void setElements​(WebElements elements)
        Set Token Elements.
        Parameters:
        elements - token elements