public interface

WebToken

com.microstrategy.web.objects.WebToken

Class Overview

This interface represents a token.

Summary

Public Methods
abstract WebElements getElements()
Get Token Elements.
abstract String getExtraValue()
Get the extra value information for the referred object.
abstract String getExtraValueType()
Get the extra value type information for the referred object.
abstract int getLevel()
Get the level of the token.
abstract WebObjectInfo getObject()
Get the object referred by this token.
abstract int getSectionType()
Get the token section type.
abstract int getState()
Get the state of the token.
abstract int getType()
Get the token type.
abstract String getValue()
Get the value of the token.
abstract void setElements(WebElements elements)
Set Token Elements.
abstract void setExtraValue(String v)
Set the extra value information for the referred object.
abstract void setExtraValueType(String vtp)
Set the extra value type information for the referred object.
abstract void setLevel(int level)
Set the level of the token.
abstract void setObject(WebObjectInfo obj)
Set the object referred by this token.
abstract void setSectionType(int sectionType)
Set the token section type.
abstract void setState(int state)
Set the state of the token.
abstract void setType(int type)
Set the token type.
abstract void setValue(String value)
Set the value of the token.

Public Methods

public abstract WebElements getElements ()

Get Token Elements.

Returns
  • Token Elements

public abstract String getExtraValue ()

Get the extra value information for the referred object.

Returns
  • extra value information for the referred object

public abstract String getExtraValueType ()

Get the extra value type information for the referred object.

Returns
  • extra value type information for the referred object

public abstract int getLevel ()

Get the level of the token.

Returns
  • level from EnumDSSXMLTokenLevels

public abstract WebObjectInfo getObject ()

Get the object referred by this token.

Returns
  • DSS object

public abstract int getSectionType ()

Get the token section type.

Returns
  • token section type form EnumDSSXMLTokenSectionTypes

public abstract int getState ()

Get the state of the token.

Returns
  • state from EnumDSSXMLTokenStates

public abstract int getType ()

Get the token type.

Returns
  • token type from EnumDSSXMLTokenTypes

public abstract String getValue ()

Get the value of the token.

Returns
  • value

public abstract void setElements (WebElements elements)

Set Token Elements.

Parameters
elements token elements

public abstract void setExtraValue (String v)

Set the extra value information for the referred object.

Parameters
v extra value information for the referred object

public abstract void setExtraValueType (String vtp)

Set the extra value type information for the referred object.

Parameters
vtp extra value type information for the referred object

public abstract void setLevel (int level)

Set the level of the token.

Parameters
level from EnumDSSXMLTokenLevels

public abstract void setObject (WebObjectInfo obj)

Set the object referred by this token.

public abstract void setSectionType (int sectionType)

Set the token section type.

public abstract void setState (int state)

Set the state of the token.

Parameters
state from EnumDSSXMLTokenStates

public abstract void setType (int type)

Set the token type.

Parameters
type form EnumDSSXMLTokenTypes

public abstract void setValue (String value)

Set the value of the token.