FieldMetadata (sdk-src 15.1.60 API)

java.lang.Object
- com.hpe.adm.nga.sdk.metadata.FieldMetadata

```
public class FieldMetadata
extends Object
```
This class hold the field metadata object and serve all functionality concern to metadata of fields. See the entity metadata REST API documentation for more information. The information that is returned in field metadata is static and therefore there are type-safe methods that can be used to return the correct information

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FieldMetadata.AccessLevel`
`static class`	`FieldMetadata.FieldType`
`class`	`FieldMetadata.FieldTypeData` This class hold the data structure of Field Field Type data
`class`	`FieldMetadata.Target` This class hold the data structure of Field Target

Constructor Summary

Constructors
Constructor and Description

FieldMetadata()

Constructors
Constructor and Description
`FieldMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canModifyAuditable()` get FieldMetadata's CanModifyAuditable
`boolean`	`canModifyEditable()` get FieldMetadata's CanModifyEditable
`boolean`	`canModifyFormat()` get FieldMetadata's CanModifyFormat
`boolean`	`canModifyLabel()` get FieldMetadata's CanModifyLabel
`boolean`	`canModifyMaxLength()` get FieldMetadata's CanModifyMaxLength
`boolean`	`canModifyRequired()` get FieldMetadata's CanModifyRequired
`boolean`	`canModifySanitization()` get FieldMetadata's CanModifySanitization
`boolean`	`canModifyUnique()` get FieldMetadata's CanModifyUnique
`boolean`	`canMofidyDescription()` get FieldMetadata's CanModifyDescription
`FieldMetadata.AccessLevel`	`getAccessLevel()` get FieldMetadata's Access Level
`boolean`	`getAuditable()` get FieldMetadata's Auditable state
`String`	`getDescription()` get FieldMetadata's Description
`String`	`getEntityName()` get FieldMetadata's Entity Name
`Object[]`	`getFieldFeatures()` get FieldMetadata's field features
`FieldMetadata.FieldType`	`getFieldType()` get FieldMetadata's field Type
`FieldMetadata.FieldTypeData`	`getFieldTypedata()` get FieldMetadata's Field Type data
`String`	`getFormat()` get FieldMetadata's format
`String`	`getLabel()` get FieldMetadata's Label
`int`	`getMaxLength()` get FieldMetadata's Max Length
`Number`	`getMaxValue()` get FieldMetadata's max value
`Number`	`getMinValue()` get FieldMetadata's min value
`String`	`getName()` get FieldMetadata's name
`String`	`getSanitization()` get FieldMetadata's Sanitization state
`String`	`getType()` get Type
`boolean`	`isAccessibleViaBusinessRules()` get FieldMetadata's VisibleInUI
`boolean`	`isEditable()` get FieldMetadata's Editable state
`boolean`	`isFilterable()` get FieldMetadata's Filterable state
`boolean`	`isFinal()` get FieldMetadata's final state
`boolean`	`isGroupable()` get FieldMetadata's Groupable state
`boolean`	`isRequired()` get FieldMetadata's Required state
`boolean`	`isReturnByDefault()` get FieldMetadata's ReturnByDefault state
`boolean`	`isSelectable()` get FieldMetadata's Selectable state
`boolean`	`isSortable()` get FieldMetadata's Sortable state
`boolean`	`isUnique()` get FieldMetadata's Unique state
`boolean`	`isUserDefined()` get FieldMetadata's UserDefined
`boolean`	`isVisibleInUI()` get FieldMetadata's VisibleInUI

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FieldMetadata
```
public FieldMetadata()
```
- Method Detail
  - getType
```
public String getType()
```
    get Type
    
    Returns:
    
    type
  - getName
```
public String getName()
```
    get FieldMetadata's name
    
    Returns:
    
    name
  - getEntityName
```
public String getEntityName()
```
    get FieldMetadata's Entity Name
    
    Returns:
    
    entity name
  - isFilterable
```
public boolean isFilterable()
```
    get FieldMetadata's Filterable state
    
    Returns:
    
    is filterable
  - isSelectable
```
public boolean isSelectable()
```
    get FieldMetadata's Selectable state
    
    Returns:
    
    is selectable
  - isEditable
```
public boolean isEditable()
```
    get FieldMetadata's Editable state
    
    Returns:
    
    is editable
  - isReturnByDefault
```
public boolean isReturnByDefault()
```
    get FieldMetadata's ReturnByDefault state
    
    Returns:
    
    is this field returned by default
  - getLabel
```
public String getLabel()
```
    get FieldMetadata's Label
    
    Returns:
    
    the field's label
  - canModifyLabel
```
public boolean canModifyLabel()
```
    get FieldMetadata's CanModifyLabel
    
    Returns:
    
    the field's canmodify label
  - isUserDefined
```
public boolean isUserDefined()
```
    get FieldMetadata's UserDefined
    
    Returns:
    
    whether the field is user defined
  - isVisibleInUI
```
public boolean isVisibleInUI()
```
    get FieldMetadata's VisibleInUI
    
    Returns:
    
    whether thr field is visible in UI
  - getAccessLevel
```
public FieldMetadata.AccessLevel getAccessLevel()
```
    get FieldMetadata's Access Level
    
    Returns:
    
    access_level
  - isAccessibleViaBusinessRules
```
public boolean isAccessibleViaBusinessRules()
```
    get FieldMetadata's VisibleInUI
    
    Returns:
    
    whether the field is accessible by business rules
  - getDescription
```
public String getDescription()
```
    get FieldMetadata's Description
    
    Returns:
    
    the field's description
  - canMofidyDescription
```
public boolean canMofidyDescription()
```
    get FieldMetadata's CanModifyDescription
    
    Returns:
    
    whether the description can be modified
  - isGroupable
```
public boolean isGroupable()
```
    get FieldMetadata's Groupable state
    
    Returns:
    
    whether the field is groupable
  - isSortable
```
public boolean isSortable()
```
    get FieldMetadata's Sortable state
    
    Returns:
    
    whether the field is sortable
  - getAuditable
```
public boolean getAuditable()
```
    get FieldMetadata's Auditable state
    
    Returns:
    
    whether the field is auditable
  - canModifyAuditable
```
public boolean canModifyAuditable()
```
    get FieldMetadata's CanModifyAuditable
    
    Returns:
    
    whether the audit label can be modified
  - getFieldFeatures
```
public Object[] getFieldFeatures()
```
    get FieldMetadata's field features
    
    Returns:
    
    a list of all features
  - getFormat
```
public String getFormat()
```
    get FieldMetadata's format
    
    Returns:
    
    the format of the field
  - getMinValue
```
public Number getMinValue()
```
    get FieldMetadata's min value
    
    Returns:
    
    the min value (if relevant)
  - getMaxValue
```
public Number getMaxValue()
```
    get FieldMetadata's max value
    
    Returns:
    
    the max value (if relevant)
  - isFinal
```
public boolean isFinal()
```
    get FieldMetadata's final state
    
    Returns:
    
    the final status
  - isRequired
```
public boolean isRequired()
```
    get FieldMetadata's Required state
    
    Returns:
    
    whether the field is required
  - getSanitization
```
public String getSanitization()
```
    get FieldMetadata's Sanitization state
    
    Returns:
    
    whether the field is sanitized
  - isUnique
```
public boolean isUnique()
```
    get FieldMetadata's Unique state
    
    Returns:
    
    whether the field is unique
  - getFieldType
```
public FieldMetadata.FieldType getFieldType()
```
    get FieldMetadata's field Type
    
    Returns:
    
    the type of the field
  - getFieldTypedata
```
public FieldMetadata.FieldTypeData getFieldTypedata()
```
    get FieldMetadata's Field Type data
    
    Returns:
    
    the typedata of the field
  - getMaxLength
```
public int getMaxLength()
```
    get FieldMetadata's Max Length
    
    Returns:
    
    the max length
  - canModifyRequired
```
public boolean canModifyRequired()
```
    get FieldMetadata's CanModifyRequired
    
    Returns:
    
    whether the required can be modified
  - canModifyFormat
```
public boolean canModifyFormat()
```
    get FieldMetadata's CanModifyFormat
    
    Returns:
    
    whether the format can be modified
  - canModifyMaxLength
```
public boolean canModifyMaxLength()
```
    get FieldMetadata's CanModifyMaxLength
    
    Returns:
    
    whether the max length can be modified
  - canModifyUnique
```
public boolean canModifyUnique()
```
    get FieldMetadata's CanModifyUnique
    
    Returns:
    
    whether the uniqueness can be modified
  - canModifyEditable
```
public boolean canModifyEditable()
```
    get FieldMetadata's CanModifyEditable
    
    Returns:
    
    whether the editibility can be modified
  - canModifySanitization
```
public boolean canModifySanitization()
```
    get FieldMetadata's CanModifySanitization
    
    Returns:
    
    whether the sanitization can be modified

Class FieldMetadata

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FieldMetadata

Method Detail

getType

getName

getEntityName

isFilterable

isSelectable

isEditable

isReturnByDefault

getLabel

canModifyLabel

isUserDefined

isVisibleInUI

getAccessLevel

isAccessibleViaBusinessRules

getDescription

canMofidyDescription

isGroupable

isSortable

getAuditable

canModifyAuditable

getFieldFeatures

getFormat

getMinValue

getMaxValue

isFinal

isRequired

getSanitization

isUnique

getFieldType

getFieldTypedata

getMaxLength

canModifyRequired

canModifyFormat

canModifyMaxLength

canModifyUnique

canModifyEditable

canModifySanitization