Class ColumnItem

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

    public final class ColumnItem
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Represents a column of the Grid
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        ColumnItem()
      Default constructor.
      protected ColumnItem​(com.vmware.vapi.data.StructValue __dynamicStructureFields)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends com.vmware.vapi.bindings.Structure>
      T
      _convertTo​(java.lang.Class<T> clazz)  
      java.lang.String _getCanonicalName()  
      static java.lang.String _getCanonicalTypeName()
      Returns the canonical type name.
      static com.vmware.vapi.bindings.type.StructType _getClassType()
      WARNING: Internal method, subject to change in future versions.
      com.vmware.vapi.data.StructValue _getDataValue()  
      com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)  
      java.util.Set<java.lang.String> _getDynamicFieldNames()  
      com.vmware.vapi.bindings.type.StructType _getType()  
      boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)  
      static ColumnItem _newInstance​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Returns new instance of this binding class and injects the provided data value.
      WARNING: The returned object is not fully initialized.
      static ColumnItem _newInstance2​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)  
      protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)  
      void _validate()  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getColumnIdentifier()
      Identifies the column and used for fetching content upon an user click or drilldown.
      java.lang.String getDrilldownId()
      Id of drilldown widget, if any.
      java.lang.String getField()
      Field from which values of the column will be derived.
      java.lang.Boolean getHidden()
      If set to true, hides the column
      Label getLabel()  
      java.lang.String getNavigation()
      Hyperlink of the specified UI page that provides details.
      java.util.List<RenderConfiguration> getRenderConfiguration()
      Render configuration to be applied, if any.
      java.lang.Boolean getSortAscending()
      If true, the value of the column are sorted in ascending order.
      java.lang.String getSortKey()
      Sorting on column is based on the sort_key.
      java.util.List<Tooltip> getTooltip()
      Multi-line text to be shown on tooltip while hovering over a cell in the grid.
      java.lang.String getType()
      Possible values are: TYPE_STRING TYPE_NUMBER TYPE_DATE Data type of the field.
      int hashCode()  
      void setColumnIdentifier​(java.lang.String columnIdentifier)
      Identifies the column and used for fetching content upon an user click or drilldown.
      void setDrilldownId​(java.lang.String drilldownId)
      Id of drilldown widget, if any.
      void setField​(java.lang.String field)
      Field from which values of the column will be derived.
      void setHidden​(java.lang.Boolean hidden)
      If set to true, hides the column
      void setLabel​(Label label)  
      void setNavigation​(java.lang.String navigation)
      Hyperlink of the specified UI page that provides details.
      void setRenderConfiguration​(java.util.List<RenderConfiguration> renderConfiguration)
      Render configuration to be applied, if any.
      void setSortAscending​(java.lang.Boolean sortAscending)
      If true, the value of the column are sorted in ascending order.
      void setSortKey​(java.lang.String sortKey)
      Sorting on column is based on the sort_key.
      void setTooltip​(java.util.List<Tooltip> tooltip)
      Multi-line text to be shown on tooltip while hovering over a cell in the grid.
      void setType​(java.lang.String type)
      Possible values are: TYPE_STRING TYPE_NUMBER TYPE_DATE Data type of the field.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields
    • Constructor Detail

      • ColumnItem

        public ColumnItem()
        Default constructor.
      • ColumnItem

        protected ColumnItem​(com.vmware.vapi.data.StructValue __dynamicStructureFields)
    • Method Detail

      • getColumnIdentifier

        public java.lang.String getColumnIdentifier()
        Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column's data will not participate in searches and drilldowns.
        Returns:
        The current value of the property.
      • setColumnIdentifier

        public void setColumnIdentifier​(java.lang.String columnIdentifier)
        Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column's data will not participate in searches and drilldowns.
        Parameters:
        columnIdentifier - New value for the property.
      • getDrilldownId

        public java.lang.String getDrilldownId()
        Id of drilldown widget, if any. Id should be a valid id of an existing widget.
        Returns:
        The current value of the property.
      • setDrilldownId

        public void setDrilldownId​(java.lang.String drilldownId)
        Id of drilldown widget, if any. Id should be a valid id of an existing widget.
        Parameters:
        drilldownId - New value for the property.
      • getField

        public java.lang.String getField()
        Field from which values of the column will be derived.
        Returns:
        The current value of the property.
      • setField

        public void setField​(java.lang.String field)
        Field from which values of the column will be derived.
        Parameters:
        field - New value for the property.
      • getHidden

        public java.lang.Boolean getHidden()
        If set to true, hides the column
        Returns:
        The current value of the property.
      • setHidden

        public void setHidden​(java.lang.Boolean hidden)
        If set to true, hides the column
        Parameters:
        hidden - New value for the property.
      • getLabel

        public Label getLabel()
        Returns:
        The current value of the property.
      • setLabel

        public void setLabel​(Label label)
        Parameters:
        label - New value for the property.
      • getNavigation

        public java.lang.String getNavigation()
        Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.
        Returns:
        The current value of the property.
      • setNavigation

        public void setNavigation​(java.lang.String navigation)
        Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.
        Parameters:
        navigation - New value for the property.
      • getRenderConfiguration

        public java.util.List<RenderConfiguration> getRenderConfiguration()
        Render configuration to be applied, if any.
        Returns:
        The current value of the property.
      • setRenderConfiguration

        public void setRenderConfiguration​(java.util.List<RenderConfiguration> renderConfiguration)
        Render configuration to be applied, if any.
        Parameters:
        renderConfiguration - New value for the property.
      • getSortAscending

        public java.lang.Boolean getSortAscending()
        If true, the value of the column are sorted in ascending order. Otherwise, in descending order.
        Returns:
        The current value of the property.
      • setSortAscending

        public void setSortAscending​(java.lang.Boolean sortAscending)
        If true, the value of the column are sorted in ascending order. Otherwise, in descending order.
        Parameters:
        sortAscending - New value for the property.
      • getSortKey

        public java.lang.String getSortKey()
        Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.
        Returns:
        The current value of the property.
      • setSortKey

        public void setSortKey​(java.lang.String sortKey)
        Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.
        Parameters:
        sortKey - New value for the property.
      • getTooltip

        public java.util.List<Tooltip> getTooltip()
        Multi-line text to be shown on tooltip while hovering over a cell in the grid.
        Returns:
        The current value of the property.
      • setTooltip

        public void setTooltip​(java.util.List<Tooltip> tooltip)
        Multi-line text to be shown on tooltip while hovering over a cell in the grid.
        Parameters:
        tooltip - New value for the property.
      • getType

        public java.lang.String getType()
        Possible values are: Data type of the field.
        Returns:
        The current value of the property.
      • setType

        public void setType​(java.lang.String type)
        Possible values are: Data type of the field.
        Parameters:
        type - New value for the property.
      • _getType

        public com.vmware.vapi.bindings.type.StructType _getType()
        Specified by:
        _getType in interface com.vmware.vapi.bindings.StaticStructure
      • _getDataValue

        public com.vmware.vapi.data.StructValue _getDataValue()
        Specified by:
        _getDataValue in interface com.vmware.vapi.bindings.Structure
      • _updateDataValue

        protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)
      • _validate

        public void _validate()
        Specified by:
        _validate in interface com.vmware.vapi.bindings.StaticStructure
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface com.vmware.vapi.bindings.StaticStructure
        Overrides:
        toString in class java.lang.Object
      • _hasTypeNameOf

        public boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
        Specified by:
        _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
      • _convertTo

        public <T extends com.vmware.vapi.bindings.Structure> T _convertTo​(java.lang.Class<T> clazz)
        Specified by:
        _convertTo in interface com.vmware.vapi.bindings.Structure
      • _setDynamicField

        public void _setDynamicField​(java.lang.String fieldName,
                                     com.vmware.vapi.data.DataValue fieldValue)
        Specified by:
        _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
      • _getDynamicField

        public com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)
        Specified by:
        _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
      • _getDynamicFieldNames

        public java.util.Set<java.lang.String> _getDynamicFieldNames()
        Specified by:
        _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
      • _getClassType

        public static com.vmware.vapi.bindings.type.StructType _getClassType()
        WARNING: Internal method, subject to change in future versions.
        Returns:
        StructType instance representing the static bindings type for this Structure.
      • _getCanonicalName

        public java.lang.String _getCanonicalName()
        Specified by:
        _getCanonicalName in interface com.vmware.vapi.bindings.Structure
      • _getCanonicalTypeName

        public static java.lang.String _getCanonicalTypeName()
        Returns the canonical type name. See _getCanonicalName().
        Returns:
        canonical type name
      • _newInstance

        public static ColumnItem _newInstance​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Returns new instance of this binding class and injects the provided data value.
        WARNING: The returned object is not fully initialized.
        Parameters:
        structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
        Returns:
        the static bindings StructType
      • _newInstance2

        public static ColumnItem _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.