LogicalDomain (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.LogicalDomain

```
public class LogicalDomain
extends Reference
```
POJO for the logical_domain asset type in IGC, displayed as 'Logical Domain' 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 ReferenceList`	`child_domains` The `child_domains` property, displayed as 'Child Domains' in the IGC UI.
`protected String`	`created_by` The `created_by` property, displayed as 'Created By' in the IGC UI.
`protected Date`	`created_on` The `created_on` property, displayed as 'Created On' in the IGC UI.
`protected String`	`data_type` The `data_type` property, displayed as 'Data Type' in the IGC UI.
`protected String`	`default_value` The `default_value` property, displayed as 'Default Value' in the IGC UI.
`protected ReferenceList`	`entity_attributes` The `entity_attributes` property, displayed as 'Entity Attributes' in the IGC UI.
`protected Number`	`length` The `length` property, displayed as 'Length' in the IGC UI.
`protected Reference`	`logical_data_model` The `logical_data_model` property, displayed as 'Logical Data Model' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected String`	`modified_by` The `modified_by` property, displayed as 'Modified By' in the IGC UI.
`protected Date`	`modified_on` The `modified_on` property, displayed as 'Modified On' in the IGC UI.
`protected String`	`name` The `name` property, displayed as 'Name' in the IGC UI.
`protected String`	`native_type` The `native_type` property, displayed as 'Native Type' in the IGC UI.
`protected String`	`null_value` The `null_value` property, displayed as 'Null Value' in the IGC UI.
`protected Reference`	`parent_domain` The `parent_domain` property, displayed as 'Parent Domain' in the IGC UI.
`protected Number`	`scale` The `scale` property, displayed as 'Scale' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' 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

LogicalDomain()

Constructors
Constructor and Description
`LogicalDomain()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getChildDomains()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`String`	`getDataType()`
`String`	`getDefaultValue()`
`ReferenceList`	`getEntityAttributes()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`Number`	`getLength()`
`Reference`	`getLogicalDataModel()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`String`	`getNativeType()`
`static List<String>`	`getNonRelationshipProperties()`
`String`	`getNullValue()`
`static List<String>`	`getPagedRelationshipProperties()`
`Reference`	`getParentDomain()`
`Number`	`getScale()`
`String`	`getShortDescription()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isLogicalDomain(Object obj)`
`void`	`setChildDomains(ReferenceList child_domains)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDataType(String data_type)`
`void`	`setDefaultValue(String default_value)`
`void`	`setEntityAttributes(ReferenceList entity_attributes)`
`void`	`setLength(Number length)`
`void`	`setLogicalDataModel(Reference logical_data_model)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setNativeType(String native_type)`
`void`	`setNullValue(String null_value)`
`void`	`setParentDomain(Reference parent_domain)`
`void`	`setScale(Number scale)`
`void`	`setShortDescription(String short_description)`
`void`	`setTheName(String name)`

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.
  - logical_data_model
```
protected Reference logical_data_model
```
    The logical_data_model property, displayed as 'Logical Data Model' in the IGC UI.
    
    Will be a single Reference to a LogicalDataModel object.
  - entity_attributes
```
protected ReferenceList entity_attributes
```
    The entity_attributes property, displayed as 'Entity Attributes' in the IGC UI.
    
    Will be a ReferenceList of EntityAttribute objects.
  - parent_domain
```
protected Reference parent_domain
```
    The parent_domain property, displayed as 'Parent Domain' in the IGC UI.
    
    Will be a single Reference to a LogicalDomain object.
  - child_domains
```
protected ReferenceList child_domains
```
    The child_domains property, displayed as 'Child Domains' in the IGC UI.
    
    Will be a ReferenceList of LogicalDomain objects.
  - data_type
```
protected String data_type
```
    The data_type property, displayed as 'Data Type' in the IGC UI.
  - native_type
```
protected String native_type
```
    The native_type property, displayed as 'Native Type' in the IGC UI.
  - default_value
```
protected String default_value
```
    The default_value property, displayed as 'Default Value' in the IGC UI.
  - null_value
```
protected String null_value
```
    The null_value property, displayed as 'Null Value' in the IGC UI.
  - length
```
protected Number length
```
    The length property, displayed as 'Length' in the IGC UI.
  - scale
```
protected Number scale
```
    The scale property, displayed as 'Scale' in the IGC UI.
  - created_by
```
protected String created_by
```
    The created_by property, displayed as 'Created By' in the IGC UI.
  - created_on
```
protected Date created_on
```
    The created_on property, displayed as 'Created On' in the IGC UI.
  - modified_by
```
protected String modified_by
```
    The modified_by property, displayed as 'Modified By' in the IGC UI.
  - modified_on
```
protected Date modified_on
```
    The modified_on property, displayed as 'Modified On' in the IGC UI.
- Constructor Detail
  - LogicalDomain
```
public LogicalDomain()
```
- 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
  - getLogicalDataModel
```
public Reference getLogicalDataModel()
```
    See Also:
    
    logical_data_model
  - setLogicalDataModel
```
public void setLogicalDataModel(Reference logical_data_model)
```
    See Also:
    
    logical_data_model
  - getEntityAttributes
```
public ReferenceList getEntityAttributes()
```
    See Also:
    
    entity_attributes
  - setEntityAttributes
```
public void setEntityAttributes(ReferenceList entity_attributes)
```
    See Also:
    
    entity_attributes
  - getParentDomain
```
public Reference getParentDomain()
```
    See Also:
    
    parent_domain
  - setParentDomain
```
public void setParentDomain(Reference parent_domain)
```
    See Also:
    
    parent_domain
  - getChildDomains
```
public ReferenceList getChildDomains()
```
    See Also:
    
    child_domains
  - setChildDomains
```
public void setChildDomains(ReferenceList child_domains)
```
    See Also:
    
    child_domains
  - getDataType
```
public String getDataType()
```
    See Also:
    
    data_type
  - setDataType
```
public void setDataType(String data_type)
```
    See Also:
    
    data_type
  - getNativeType
```
public String getNativeType()
```
    See Also:
    
    native_type
  - setNativeType
```
public void setNativeType(String native_type)
```
    See Also:
    
    native_type
  - getDefaultValue
```
public String getDefaultValue()
```
    See Also:
    
    default_value
  - setDefaultValue
```
public void setDefaultValue(String default_value)
```
    See Also:
    
    default_value
  - getNullValue
```
public String getNullValue()
```
    See Also:
    
    null_value
  - setNullValue
```
public void setNullValue(String null_value)
```
    See Also:
    
    null_value
  - getLength
```
public Number getLength()
```
    See Also:
    
    length
  - setLength
```
public void setLength(Number length)
```
    See Also:
    
    length
  - getScale
```
public Number getScale()
```
    See Also:
    
    scale
  - setScale
```
public void setScale(Number scale)
```
    See Also:
    
    scale
  - getCreatedBy
```
public String getCreatedBy()
```
    See Also:
    
    created_by
  - setCreatedBy
```
public void setCreatedBy(String created_by)
```
    See Also:
    
    created_by
  - getCreatedOn
```
public Date getCreatedOn()
```
    See Also:
    
    created_on
  - setCreatedOn
```
public void setCreatedOn(Date created_on)
```
    See Also:
    
    created_on
  - getModifiedBy
```
public String getModifiedBy()
```
    See Also:
    
    modified_by
  - setModifiedBy
```
public void setModifiedBy(String modified_by)
```
    See Also:
    
    modified_by
  - getModifiedOn
```
public Date getModifiedOn()
```
    See Also:
    
    modified_on
  - setModifiedOn
```
public void setModifiedOn(Date modified_on)
```
    See Also:
    
    modified_on
  - 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()
```
  - isLogicalDomain
```
public static Boolean isLogicalDomain(Object obj)
```

Class LogicalDomain

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

logical_data_model

entity_attributes

parent_domain

child_domains

data_type

native_type

default_value

null_value

length

scale

created_by

created_on

modified_by

modified_on

Constructor Detail

LogicalDomain

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLogicalDataModel

setLogicalDataModel

getEntityAttributes

setEntityAttributes

getParentDomain

setParentDomain

getChildDomains

setChildDomains

getDataType

setDataType

getNativeType

setNativeType

getDefaultValue

setDefaultValue

getNullValue

setNullValue

getLength

setLength

getScale

setScale

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

canBeCreated

includesModificationDetails

getNonRelationshipProperties

getStringProperties

getPagedRelationshipProperties

getAllProperties

isLogicalDomain