Package com.microstrategy.web.objects

Interface RWUnitInfo

  • All Superinterfaces:
    KeyedObject
    All Known Implementing Classes:
    RWUnitInfoImpl
    public interface RWUnitInfo
extends KeyedObject
    This class represents the document unit (attribute and metric) properties. It is designed to modify some properties of the unit object without affecting the source report of a document.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAlias()
      get the alias of this document unit
      java.lang.String getComment()
      get the comment of this document unit
      WebFormat getFormat()
      get the format of this document unit
      WebObjectInfo getTarget()
      get the target(attribute and metric) of this document unit, the reference to the template unit object that the document unit properties will override
      boolean isHidden()
      get the hidden status of this document unit.
      void setAlias​(java.lang.String _alias)
      set the alias of this document unit
      void setComment​(java.lang.String _comment)
      set the comment of this document unit
      void setFormat​(WebFormat _format)
      set the format of this document unit
      void setHidden​(java.lang.Boolean _hidden)
      set the hidden status of this document unit
      void setTarget​(WebObjectInfo _target)
      set the target(attribute and metric) of this document unit

    • Method Detail

      • getAlias

        java.lang.String getAlias()
        get the alias of this document unit
        Returns:
        the alias of this document unit

      • setAlias

        void setAlias​(java.lang.String _alias)
        set the alias of this document unit
        Parameters:
        _alias -

      • isHidden

        boolean isHidden()
        get the hidden status of this document unit.
        Returns:
        the status whether this unit is hidden

      • setHidden

        void setHidden​(java.lang.Boolean _hidden)
        set the hidden status of this document unit
        Parameters:
        _hidden -

      • getComment

        java.lang.String getComment()
        get the comment of this document unit
        Returns:
        the comment of this document unit

      • setComment

        void setComment​(java.lang.String _comment)
        set the comment of this document unit
        Parameters:
        _comment -

      • getTarget

        WebObjectInfo getTarget()
        get the target(attribute and metric) of this document unit, the reference to the template unit object that the document unit properties will override
        Returns:
        the target(attribute and metric) of this document unit

      • setTarget

        void setTarget​(WebObjectInfo _target)
        set the target(attribute and metric) of this document unit
        Parameters:
        _target -

      • getFormat

        WebFormat getFormat()
        get the format of this document unit
        Returns:
        the format of this document unit

      • setFormat

        void setFormat​(WebFormat _format)
        set the format of this document unit
        Parameters:
        _format -