DataItem (IBM Information Governance Catalog REST API Client Library 1.0 API)

java.lang.Object
- org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
- - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
  - - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.generated.v11501.DataItem

```
public class DataItem
extends Reference
```
POJO for the data_item asset type in IGC, displayed as 'Data Item' in the IGC UI.

(this code has been generated based on out-of-the-box IGC metadata types; if modifications are needed, eg. to handle custom attributes, extending from this class in your own custom class is the best approach.)

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`allow_null_values` The `allow_null_values` property, displayed as 'Null Value' in the IGC UI.
`protected Boolean`	`allows_empty_value` The `allows_empty_value` property, displayed as 'Allows Empty Value' in the IGC UI.
`protected Boolean`	`allows_null_values` The `allows_null_values` property, displayed as 'Allow Null Values' in the IGC UI.
`protected ReferenceList`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' in the IGC UI.
`protected String`	`based_on` The `based_on` property, displayed as 'Based On ' in the IGC UI.
`protected String`	`calendar` The `calendar` property, displayed as 'Calendar' in the IGC UI.
`protected Reference`	`data_item_definition` The `data_item_definition` property, displayed as 'Data Item Definition' in the IGC UI.
`protected String`	`data_type` The `data_type` property, displayed as 'Type Code' in the IGC UI.
`protected String`	`default_value` The `default_value` property, displayed as 'Default Value' in the IGC UI.
`protected Number`	`display_size` The `display_size` property, displayed as 'Display Size' in the IGC UI.
`protected Number`	`fraction` The `fraction` property, displayed as 'Scale' in the IGC UI.
`protected ReferenceList`	`governed_by_rules` The `governed_by_rules` property, displayed as 'Governed by Rules' in the IGC UI.
`protected ReferenceList`	`has_dimension` The `has_dimension` property, displayed as 'Has Dimension' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected Boolean`	`is_computed` The `is_computed` property, displayed as 'Is Computed' in the IGC UI.
`protected Boolean`	`is_signed` The `is_signed` property, displayed as 'Is Signed' in the IGC UI.
`protected String`	`item_kind` The `item_kind` property, displayed as 'Item Kind' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected Number`	`length` The `length` property, displayed as 'Maximum Length' in the IGC UI.
`protected Number`	`level` The `level` property, displayed as 'Level Number' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected Number`	`minimum_length` The `minimum_length` property, displayed as 'Minimum Length' in the IGC UI.
`protected String`	`name` The `name` property, displayed as 'Name' in the IGC UI.
`protected String`	`odbc_type` The `odbc_type` property, displayed as 'ODBC Type' in the IGC UI.
`protected Number`	`position` The `position` property, displayed as 'Position' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected String`	`type` The `type` property, displayed as 'Native Type' in the IGC UI.
`protected Boolean`	`unique` The `unique` property, displayed as 'Unique' in the IGC UI.
`protected ReferenceList`	`validated_by_data_values` The `validated_by_data_values` property, displayed as 'Validated By Data Values' in the IGC UI.

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
_context, _id, _name, _type, _url

Constructor Summary

Constructors
Constructor and Description

DataItem()

Constructors
Constructor and Description
`DataItem()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`String`	`getAllowNullValues()`
`Boolean`	`getAllowsEmptyValue()`
`Boolean`	`getAllowsNullValues()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAssignedToTerms()`
`String`	`getBasedOn()`
`String`	`getCalendar()`
`Reference`	`getDataItemDefinition()`
`String`	`getDataType()`
`String`	`getDefaultValue()`
`Number`	`getDisplaySize()`
`Number`	`getFraction()`
`ReferenceList`	`getGovernedByRules()`
`ReferenceList`	`getHasDimension()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`Boolean`	`getIsComputed()`
`Boolean`	`getIsSigned()`
`String`	`getItemKind()`
`ReferenceList`	`getLabels()`
`Number`	`getLength()`
`Number`	`getLevel()`
`String`	`getLongDescription()`
`Number`	`getMinimumLength()`
`static List<String>`	`getNonRelationshipProperties()`
`String`	`getOdbcType()`
`static List<String>`	`getPagedRelationshipProperties()`
`Number`	`getPosition()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`String`	`getTheType()`
`Boolean`	`getUnique()`
`ReferenceList`	`getValidatedByDataValues()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isDataItem(Object obj)`
`void`	`setAllowNullValues(String allow_null_values)`
`void`	`setAllowsEmptyValue(Boolean allows_empty_value)`
`void`	`setAllowsNullValues(Boolean allows_null_values)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setBasedOn(String based_on)`
`void`	`setCalendar(String calendar)`
`void`	`setDataItemDefinition(Reference data_item_definition)`
`void`	`setDataType(String data_type)`
`void`	`setDefaultValue(String default_value)`
`void`	`setDisplaySize(Number display_size)`
`void`	`setFraction(Number fraction)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setHasDimension(ReferenceList has_dimension)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setIsComputed(Boolean is_computed)`
`void`	`setIsSigned(Boolean is_signed)`
`void`	`setItemKind(String item_kind)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLength(Number length)`
`void`	`setLevel(Number level)`
`void`	`setLongDescription(String long_description)`
`void`	`setMinimumLength(Number minimum_length)`
`void`	`setOdbcType(String odbc_type)`
`void`	`setPosition(Number position)`
`void`	`setShortDescription(String short_description)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setTheType(String type)`
`void`	`setUnique(Boolean unique)`
`void`	`setValidatedByDataValues(ReferenceList validated_by_data_values)`

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
canAssetBeCreatedFromPOJO, getAllPropertiesFromPOJO, getAssetDetails, getAssetTypeForSearch, getAssetTypeFromPOJO, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getContext, getDisplayNameFromPOJO, getFieldByName, getFullAssetDetails, getId, getIdentity, getName, getNonRelationshipPropertiesFromPOJO, getPagedRelationalPropertiesFromPOJO, getPropertyByName, getStringPropertiesFromPOJO, getType, getUrl, hasModificationDetails, hasModificationDetails, hasProperty, isCreatableFromPOJO, isFullyRetrieved, isReference, isReference, isReferenceList, isReferenceList, isSimpleType, isSimpleType, populateContext, populateModificationDetails, setContext, setFullyRetrieved, setId, setName, setPropertyByName, setType, setUrl

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
getAllFields, toString

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

- Field Detail
  - name
```
protected String name
```
    The name property, displayed as 'Name' in the IGC UI.
  - short_description
```
protected String short_description
```
    The short_description property, displayed as 'Short Description' in the IGC UI.
  - long_description
```
protected String long_description
```
    The long_description property, displayed as 'Long Description' in the IGC UI.
  - labels
```
protected ReferenceList labels
```
    The labels property, displayed as 'Labels' in the IGC UI.
    
    Will be a ReferenceList of Label objects.
  - stewards
```
protected ReferenceList stewards
```
    The stewards property, displayed as 'Stewards' in the IGC UI.
    
    Will be a ReferenceList of AsclSteward objects.
  - assigned_to_terms
```
protected ReferenceList assigned_to_terms
```
    The assigned_to_terms property, displayed as 'Assigned to Terms' in the IGC UI.
    
    Will be a ReferenceList of Term objects.
  - implements_rules
```
protected ReferenceList implements_rules
```
    The implements_rules property, displayed as 'Implements Rules' in the IGC UI.
    
    Will be a ReferenceList of InformationGovernanceRule objects.
  - governed_by_rules
```
protected ReferenceList governed_by_rules
```
    The governed_by_rules property, displayed as 'Governed by Rules' in the IGC UI.
    
    Will be a ReferenceList of InformationGovernanceRule objects.
  - data_item_definition
```
protected Reference data_item_definition
```
    The data_item_definition property, displayed as 'Data Item Definition' in the IGC UI.
    
    Will be a single Reference to a DataItemDefinition object.
  - is_signed
```
protected Boolean is_signed
```
    The is_signed property, displayed as 'Is Signed' in the IGC UI.
  - validated_by_data_values
```
protected ReferenceList validated_by_data_values
```
    The validated_by_data_values property, displayed as 'Validated By Data Values' in the IGC UI.
    
    Will be a ReferenceList of DataItemValue objects.
  - type
```
protected String type
```
    The type property, displayed as 'Native Type' in the IGC UI.
  - is_computed
```
protected Boolean is_computed
```
    The is_computed property, displayed as 'Is Computed' in the IGC UI.
  - allows_empty_value
```
protected Boolean allows_empty_value
```
    The allows_empty_value property, displayed as 'Allows Empty Value' in the IGC UI.
  - odbc_type
```
protected String odbc_type
```
    The odbc_type property, displayed as 'ODBC Type' in the IGC UI.
    
    Can be one of the following values:
    - CHAR (displayed in the UI as 'CHAR')
    - VARCHAR (displayed in the UI as 'VARCHAR')
    - LONGVARCHAR (displayed in the UI as 'LONGVARCHAR')
    - WCHAR (displayed in the UI as 'WCHAR')
    - WVARCHAR (displayed in the UI as 'WVARCHAR')
    - WLONGVARCHAR (displayed in the UI as 'WLONGVARCHAR')
    - DECIMAL (displayed in the UI as 'DECIMAL')
    - NUMERIC (displayed in the UI as 'NUMERIC')
    - SMALLINT (displayed in the UI as 'SMALLINT')
    - INTEGER (displayed in the UI as 'INTEGER')
    - REAL (displayed in the UI as 'REAL')
    - FLOAT (displayed in the UI as 'FLOAT')
    - DOUBLE (displayed in the UI as 'DOUBLE')
    - BIT (displayed in the UI as 'BIT')
    - TINYINT (displayed in the UI as 'TINYINT')
    - BIGINT (displayed in the UI as 'BIGINT')
    - BINARY (displayed in the UI as 'BINARY')
    - VARBINARY (displayed in the UI as 'VARBINARY')
    - LONGVARBINARY (displayed in the UI as 'LONGVARBINARY')
    - DATE (displayed in the UI as 'DATE')
    - TIME (displayed in the UI as 'TIME')
    - TIMESTAMP (displayed in the UI as 'TIMESTAMP')
    - GUID (displayed in the UI as 'GUID')
    - UNKNOWN (displayed in the UI as 'UNKNOWN')
  - based_on
```
protected String based_on
```
    The based_on property, displayed as 'Based On ' in the IGC UI.
  - position
```
protected Number position
```
    The position property, displayed as 'Position' in the IGC UI.
  - allow_null_values
```
protected String allow_null_values
```
    The allow_null_values property, displayed as 'Null Value' in the IGC UI.
  - fraction
```
protected Number fraction
```
    The fraction property, displayed as 'Scale' in the IGC UI.
  - allows_null_values
```
protected Boolean allows_null_values
```
    The allows_null_values property, displayed as 'Allow Null Values' in the IGC UI.
  - calendar
```
protected String calendar
```
    The calendar property, displayed as 'Calendar' in the IGC UI.
  - display_size
```
protected Number display_size
```
    The display_size property, displayed as 'Display Size' in the IGC UI.
  - minimum_length
```
protected Number minimum_length
```
    The minimum_length property, displayed as 'Minimum Length' in the IGC UI.
  - item_kind
```
protected String item_kind
```
    The item_kind property, displayed as 'Item Kind' in the IGC UI.
  - has_dimension
```
protected ReferenceList has_dimension
```
    The has_dimension property, displayed as 'Has Dimension' in the IGC UI.
    
    Will be a ReferenceList of Array objects.
  - unique
```
protected Boolean unique
```
    The unique property, displayed as 'Unique' in the IGC UI.
  - length
```
protected Number length
```
    The length property, displayed as 'Maximum Length' in the IGC UI.
  - data_type
```
protected String data_type
```
    The data_type property, displayed as 'Type Code' in the IGC UI.
    
    Can be one of the following values:
    - INT8 (displayed in the UI as 'INT8')
    - INT16 (displayed in the UI as 'INT16')
    - INT32 (displayed in the UI as 'INT32')
    - INT64 (displayed in the UI as 'INT64')
    - SFLOAT (displayed in the UI as 'SFLOAT')
    - DFLOAT (displayed in the UI as 'DFLOAT')
    - QFLOAT (displayed in the UI as 'QFLOAT')
    - DECIMAL (displayed in the UI as 'DECIMAL')
    - STRING (displayed in the UI as 'STRING')
    - BINARY (displayed in the UI as 'BINARY')
    - BOOLEAN (displayed in the UI as 'BOOLEAN')
    - DATE (displayed in the UI as 'DATE')
    - TIME (displayed in the UI as 'TIME')
    - DATETIME (displayed in the UI as 'DATETIME')
    - DURATION (displayed in the UI as 'DURATION')
    - CHOICE (displayed in the UI as 'CHOICE')
    - ORDERED_GROUP (displayed in the UI as 'ORDERED_GROUP')
    - UNORDERED_GROUP (displayed in the UI as 'UNORDERED_GROUP')
    - GUID (displayed in the UI as 'GUID')
    - UNKNOWN (displayed in the UI as 'UNKNOWN')
    - JSON (displayed in the UI as 'JSON')
    - XML (displayed in the UI as 'XML')
  - default_value
```
protected String default_value
```
    The default_value property, displayed as 'Default Value' in the IGC UI.
  - level
```
protected Number level
```
    The level property, displayed as 'Level Number' in the IGC UI.
- Constructor Detail
  - DataItem
```
public DataItem()
```
- Method Detail
  - getIgcTypeId
```
public static String getIgcTypeId()
```
  - getIgcTypeDisplayName
```
public static String getIgcTypeDisplayName()
```
  - getTheName
```
public String getTheName()
```
    See Also:
    
    name
  - setTheName
```
public void setTheName(String name)
```
    See Also:
    
    name
  - getShortDescription
```
public String getShortDescription()
```
    See Also:
    
    short_description
  - setShortDescription
```
public void setShortDescription(String short_description)
```
    See Also:
    
    short_description
  - getLongDescription
```
public String getLongDescription()
```
    See Also:
    
    long_description
  - setLongDescription
```
public void setLongDescription(String long_description)
```
    See Also:
    
    long_description
  - getLabels
```
public ReferenceList getLabels()
```
    See Also:
    
    labels
  - setLabels
```
public void setLabels(ReferenceList labels)
```
    See Also:
    
    labels
  - getStewards
```
public ReferenceList getStewards()
```
    See Also:
    
    stewards
  - setStewards
```
public void setStewards(ReferenceList stewards)
```
    See Also:
    
    stewards
  - getAssignedToTerms
```
public ReferenceList getAssignedToTerms()
```
    See Also:
    
    assigned_to_terms
  - setAssignedToTerms
```
public void setAssignedToTerms(ReferenceList assigned_to_terms)
```
    See Also:
    
    assigned_to_terms
  - getImplementsRules
```
public ReferenceList getImplementsRules()
```
    See Also:
    
    implements_rules
  - setImplementsRules
```
public void setImplementsRules(ReferenceList implements_rules)
```
    See Also:
    
    implements_rules
  - getGovernedByRules
```
public ReferenceList getGovernedByRules()
```
    See Also:
    
    governed_by_rules
  - setGovernedByRules
```
public void setGovernedByRules(ReferenceList governed_by_rules)
```
    See Also:
    
    governed_by_rules
  - getDataItemDefinition
```
public Reference getDataItemDefinition()
```
    See Also:
    
    data_item_definition
  - setDataItemDefinition
```
public void setDataItemDefinition(Reference data_item_definition)
```
    See Also:
    
    data_item_definition
  - getIsSigned
```
public Boolean getIsSigned()
```
    See Also:
    
    is_signed
  - setIsSigned
```
public void setIsSigned(Boolean is_signed)
```
    See Also:
    
    is_signed
  - getValidatedByDataValues
```
public ReferenceList getValidatedByDataValues()
```
    See Also:
    
    validated_by_data_values
  - setValidatedByDataValues
```
public void setValidatedByDataValues(ReferenceList validated_by_data_values)
```
    See Also:
    
    validated_by_data_values
  - getTheType
```
public String getTheType()
```
    See Also:
    
    type
  - setTheType
```
public void setTheType(String type)
```
    See Also:
    
    type
  - getIsComputed
```
public Boolean getIsComputed()
```
    See Also:
    
    is_computed
  - setIsComputed
```
public void setIsComputed(Boolean is_computed)
```
    See Also:
    
    is_computed
  - getAllowsEmptyValue
```
public Boolean getAllowsEmptyValue()
```
    See Also:
    
    allows_empty_value
  - setAllowsEmptyValue
```
public void setAllowsEmptyValue(Boolean allows_empty_value)
```
    See Also:
    
    allows_empty_value
  - getOdbcType
```
public String getOdbcType()
```
    See Also:
    
    odbc_type
  - setOdbcType
```
public void setOdbcType(String odbc_type)
```
    See Also:
    
    odbc_type
  - getBasedOn
```
public String getBasedOn()
```
    See Also:
    
    based_on
  - setBasedOn
```
public void setBasedOn(String based_on)
```
    See Also:
    
    based_on
  - getPosition
```
public Number getPosition()
```
    See Also:
    
    position
  - setPosition
```
public void setPosition(Number position)
```
    See Also:
    
    position
  - getAllowNullValues
```
public String getAllowNullValues()
```
    See Also:
    
    allow_null_values
  - setAllowNullValues
```
public void setAllowNullValues(String allow_null_values)
```
    See Also:
    
    allow_null_values
  - getFraction
```
public Number getFraction()
```
    See Also:
    
    fraction
  - setFraction
```
public void setFraction(Number fraction)
```
    See Also:
    
    fraction
  - getAllowsNullValues
```
public Boolean getAllowsNullValues()
```
    See Also:
    
    allows_null_values
  - setAllowsNullValues
```
public void setAllowsNullValues(Boolean allows_null_values)
```
    See Also:
    
    allows_null_values
  - getCalendar
```
public String getCalendar()
```
    See Also:
    
    calendar
  - setCalendar
```
public void setCalendar(String calendar)
```
    See Also:
    
    calendar
  - getDisplaySize
```
public Number getDisplaySize()
```
    See Also:
    
    display_size
  - setDisplaySize
```
public void setDisplaySize(Number display_size)
```
    See Also:
    
    display_size
  - getMinimumLength
```
public Number getMinimumLength()
```
    See Also:
    
    minimum_length
  - setMinimumLength
```
public void setMinimumLength(Number minimum_length)
```
    See Also:
    
    minimum_length
  - getItemKind
```
public String getItemKind()
```
    See Also:
    
    item_kind
  - setItemKind
```
public void setItemKind(String item_kind)
```
    See Also:
    
    item_kind
  - getHasDimension
```
public ReferenceList getHasDimension()
```
    See Also:
    
    has_dimension
  - setHasDimension
```
public void setHasDimension(ReferenceList has_dimension)
```
    See Also:
    
    has_dimension
  - getUnique
```
public Boolean getUnique()
```
    See Also:
    
    unique
  - setUnique
```
public void setUnique(Boolean unique)
```
    See Also:
    
    unique
  - getLength
```
public Number getLength()
```
    See Also:
    
    length
  - setLength
```
public void setLength(Number length)
```
    See Also:
    
    length
  - getDataType
```
public String getDataType()
```
    See Also:
    
    data_type
  - setDataType
```
public void setDataType(String data_type)
```
    See Also:
    
    data_type
  - getDefaultValue
```
public String getDefaultValue()
```
    See Also:
    
    default_value
  - setDefaultValue
```
public void setDefaultValue(String default_value)
```
    See Also:
    
    default_value
  - getLevel
```
public Number getLevel()
```
    See Also:
    
    level
  - setLevel
```
public void setLevel(Number level)
```
    See Also:
    
    level
  - canBeCreated
```
public static Boolean canBeCreated()
```
  - includesModificationDetails
```
public static Boolean includesModificationDetails()
```
  - getNonRelationshipProperties
```
public static List<String> getNonRelationshipProperties()
```
  - getStringProperties
```
public static List<String> getStringProperties()
```
  - getPagedRelationshipProperties
```
public static List<String> getPagedRelationshipProperties()
```
  - getAllProperties
```
public static List<String> getAllProperties()
```
  - isDataItem
```
public static Boolean isDataItem(Object obj)
```

Class DataItem

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

Methods inherited from class java.lang.Object

Field Detail

name

short_description

long_description

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

data_item_definition

is_signed

validated_by_data_values

type

is_computed

allows_empty_value

odbc_type

based_on

position

allow_null_values

fraction

allows_null_values

calendar

display_size

minimum_length

item_kind

has_dimension

unique

length

data_type

default_value

level

Constructor Detail

DataItem

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getDataItemDefinition

setDataItemDefinition

getIsSigned

setIsSigned

getValidatedByDataValues

setValidatedByDataValues

getTheType

setTheType

getIsComputed

setIsComputed

getAllowsEmptyValue

setAllowsEmptyValue

getOdbcType

setOdbcType

getBasedOn

setBasedOn

getPosition

setPosition

getAllowNullValues

setAllowNullValues