Package org.labkey.remoteapi.query

Class GetQueryDetailsResponse.Column

java.lang.Object
org.labkey.remoteapi.ResponseObject
org.labkey.remoteapi.query.GetQueryDetailsResponse.Column
Enclosing class:
GetQueryDetailsResponse
public static class GetQueryDetailsResponse.Column extends ResponseObject

  • Method Details

    • getName

      public String getName()
      Returns:
      The name of the column

    • getDescription

      public String getDescription()
      Returns:
      An optional description of the column

    • getType

      public String getType()
      Returns:
      The column's data type

    • getFieldKey

      public String getFieldKey()
      Returns:
      The field key for the column. If this column comes from a foreign table, the key is a full path from the source query to this column.

    • isAutoIncrement

      public boolean isAutoIncrement()
      Returns:
      true if this column is auto-increment

    • isHidden

      public boolean isHidden()
      Returns:
      true if this column should be hidden

    • isKeyField

      public boolean isKeyField()
      Returns:
      true if this is part of the primary key

    • isMvEnabled

      public boolean isMvEnabled()
      Returns:
      true if this column is missing-value enabled

    • isNullable

      public boolean isNullable()
      Returns:
      true if this column can accept nulls

    • isReadOnly

      public boolean isReadOnly()
      Returns:
      true if this column is read-only

    • isUserEditable

      public boolean isUserEditable()
      Returns:
      true if this column may be edited by the current user

    • isVersionField

      public boolean isVersionField()
      Returns:
      true if this column is a version column

    • isSelectable

      public boolean isSelectable()
      Returns:
      true if this column may be selected

    • getCaption

      public String getCaption()
      Returns:
      The user-friendly caption for this column (may differ from name)

    • getLookup

      public GetQueryDetailsResponse.Lookup getLookup()

    • getProperties

      public Map<String,Object> getProperties()

    • isCalculated

      public boolean isCalculated()