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

```
public class LogicalEntity
extends Reference
```
POJO for the logical_entity asset type in IGC, displayed as 'Logical Entity' 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`	`alias__business_name_` The `alias_(business_name)` property, displayed as 'Alias (Business Name)' in the IGC UI.
`protected ReferenceList`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' in the IGC UI.
`protected ReferenceList`	`blueprint_elements` The `blueprint_elements` property, displayed as 'Blueprint Elements' 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 ReferenceList`	`entity_attributes` The `entity_attributes` property, displayed as 'Entity Attributes' 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`	`implemented_by_database_tables_or_views` The `implemented_by_database_tables_or_views` property, displayed as 'Implemented by Database Tables or Views' in the IGC UI.
`protected ReferenceList`	`implemented_by_design_tables_or_views` The `implemented_by_design_tables_or_views` property, displayed as 'Implemented by Design Tables or Design Views' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected String`	`imported_from` The `imported_from` property, displayed as 'Imported From' in the IGC UI.
`protected ReferenceList`	`in_collections` The `in_collections` property, displayed as 'In Collections' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected Reference`	`logical_data_model` The `logical_data_model` property, displayed as 'Logical Data Model' in the IGC UI.
`protected ReferenceList`	`logical_foreign_keys` The `logical_foreign_keys` property, displayed as 'Logical Foreign Keys' in the IGC UI.
`protected ReferenceList`	`logical_inversion_keys` The `logical_inversion_keys` property, displayed as 'Logical Inversion Keys' in the IGC UI.
`protected ReferenceList`	`logical_keys` The `logical_keys` property, displayed as 'Logical Keys' 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`	`physical_name` The `physical_name` property, displayed as 'Physical Name' 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 ReferenceList`	`subject_areas` The `subject_areas` property, displayed as 'Subject Areas' in the IGC UI.
`protected ReferenceList`	`subtypes` The `subtypes` property, displayed as 'Subtypes' in the IGC UI.
`protected ReferenceList`	`supertypes` The `supertypes` property, displayed as 'Supertypes' in the IGC UI.
`protected String`	`type` The `type` property, displayed as 'Type' 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

LogicalEntity()

Constructors
Constructor and Description
`LogicalEntity()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`String`	`getAliasBusinessName()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAssignedToTerms()`
`ReferenceList`	`getBlueprintElements()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`ReferenceList`	`getEntityAttributes()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementedByDatabaseTablesOrViews()`
`ReferenceList`	`getImplementedByDesignTablesOrViews()`
`ReferenceList`	`getImplementsRules()`
`String`	`getImportedFrom()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`Reference`	`getLogicalDataModel()`
`ReferenceList`	`getLogicalForeignKeys()`
`ReferenceList`	`getLogicalInversionKeys()`
`ReferenceList`	`getLogicalKeys()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getPhysicalName()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`ReferenceList`	`getSubjectAreas()`
`ReferenceList`	`getSubtypes()`
`ReferenceList`	`getSupertypes()`
`String`	`getTheName()`
`String`	`getTheType()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isLogicalEntity(Object obj)`
`void`	`setAliasBusinessName(String alias__business_name_)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setBlueprintElements(ReferenceList blueprint_elements)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setEntityAttributes(ReferenceList entity_attributes)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementedByDatabaseTablesOrViews(ReferenceList implemented_by_database_tables_or_views)`
`void`	`setImplementedByDesignTablesOrViews(ReferenceList implemented_by_design_tables_or_views)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setImportedFrom(String imported_from)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLogicalDataModel(Reference logical_data_model)`
`void`	`setLogicalForeignKeys(ReferenceList logical_foreign_keys)`
`void`	`setLogicalInversionKeys(ReferenceList logical_inversion_keys)`
`void`	`setLogicalKeys(ReferenceList logical_keys)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setPhysicalName(String physical_name)`
`void`	`setShortDescription(String short_description)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setSubjectAreas(ReferenceList subject_areas)`
`void`	`setSubtypes(ReferenceList subtypes)`
`void`	`setSupertypes(ReferenceList supertypes)`
`void`	`setTheName(String name)`
`void`	`setTheType(String type)`

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.
  - 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.
  - implemented_by_design_tables_or_views
```
protected ReferenceList implemented_by_design_tables_or_views
```
    The implemented_by_design_tables_or_views property, displayed as 'Implemented by Design Tables or Design Views' in the IGC UI.
    
    Will be a ReferenceList of Datagroup objects.
  - implemented_by_database_tables_or_views
```
protected ReferenceList implemented_by_database_tables_or_views
```
    The implemented_by_database_tables_or_views property, displayed as 'Implemented by Database Tables or Views' in the IGC UI.
    
    Will be a ReferenceList of Datagroup objects.
  - subject_areas
```
protected ReferenceList subject_areas
```
    The subject_areas property, displayed as 'Subject Areas' in the IGC UI.
    
    Will be a ReferenceList of SubjectArea objects.
  - 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.
  - logical_keys
```
protected ReferenceList logical_keys
```
    The logical_keys property, displayed as 'Logical Keys' in the IGC UI.
    
    Will be a ReferenceList of LogicalKey objects.
  - logical_inversion_keys
```
protected ReferenceList logical_inversion_keys
```
    The logical_inversion_keys property, displayed as 'Logical Inversion Keys' in the IGC UI.
    
    Will be a ReferenceList of LogicalInversionKey objects.
  - logical_foreign_keys
```
protected ReferenceList logical_foreign_keys
```
    The logical_foreign_keys property, displayed as 'Logical Foreign Keys' in the IGC UI.
    
    Will be a ReferenceList of LogicalForeignKey objects.
  - alias__business_name_
```
protected String alias__business_name_
```
    The alias_(business_name) property, displayed as 'Alias (Business Name)' in the IGC UI.
  - physical_name
```
protected String physical_name
```
    The physical_name property, displayed as 'Physical Name' in the IGC UI.
  - type
```
protected String type
```
    The type property, displayed as 'Type' in the IGC UI.
  - subtypes
```
protected ReferenceList subtypes
```
    The subtypes property, displayed as 'Subtypes' in the IGC UI.
    
    Will be a ReferenceList of LogicalEntity objects.
  - supertypes
```
protected ReferenceList supertypes
```
    The supertypes property, displayed as 'Supertypes' in the IGC UI.
    
    Will be a ReferenceList of LogicalEntity objects.
  - imported_from
```
protected String imported_from
```
    The imported_from property, displayed as 'Imported From' in the IGC UI.
  - blueprint_elements
```
protected ReferenceList blueprint_elements
```
    The blueprint_elements property, displayed as 'Blueprint Elements' in the IGC UI.
    
    Will be a ReferenceList of BlueprintElementLink objects.
  - in_collections
```
protected ReferenceList in_collections
```
    The in_collections property, displayed as 'In Collections' in the IGC UI.
    
    Will be a ReferenceList of Collection objects.
  - 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
  - LogicalEntity
```
public LogicalEntity()
```
- 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
  - 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
  - getImplementedByDesignTablesOrViews
```
public ReferenceList getImplementedByDesignTablesOrViews()
```
    See Also:
    
    implemented_by_design_tables_or_views
  - setImplementedByDesignTablesOrViews
```
public void setImplementedByDesignTablesOrViews(ReferenceList implemented_by_design_tables_or_views)
```
    See Also:
    
    implemented_by_design_tables_or_views
  - getImplementedByDatabaseTablesOrViews
```
public ReferenceList getImplementedByDatabaseTablesOrViews()
```
    See Also:
    
    implemented_by_database_tables_or_views
  - setImplementedByDatabaseTablesOrViews
```
public void setImplementedByDatabaseTablesOrViews(ReferenceList implemented_by_database_tables_or_views)
```
    See Also:
    
    implemented_by_database_tables_or_views
  - getSubjectAreas
```
public ReferenceList getSubjectAreas()
```
    See Also:
    
    subject_areas
  - setSubjectAreas
```
public void setSubjectAreas(ReferenceList subject_areas)
```
    See Also:
    
    subject_areas
  - getEntityAttributes
```
public ReferenceList getEntityAttributes()
```
    See Also:
    
    entity_attributes
  - setEntityAttributes
```
public void setEntityAttributes(ReferenceList entity_attributes)
```
    See Also:
    
    entity_attributes
  - getLogicalKeys
```
public ReferenceList getLogicalKeys()
```
    See Also:
    
    logical_keys
  - setLogicalKeys
```
public void setLogicalKeys(ReferenceList logical_keys)
```
    See Also:
    
    logical_keys
  - getLogicalInversionKeys
```
public ReferenceList getLogicalInversionKeys()
```
    See Also:
    
    logical_inversion_keys
  - setLogicalInversionKeys
```
public void setLogicalInversionKeys(ReferenceList logical_inversion_keys)
```
    See Also:
    
    logical_inversion_keys
  - getLogicalForeignKeys
```
public ReferenceList getLogicalForeignKeys()
```
    See Also:
    
    logical_foreign_keys
  - setLogicalForeignKeys
```
public void setLogicalForeignKeys(ReferenceList logical_foreign_keys)
```
    See Also:
    
    logical_foreign_keys
  - getAliasBusinessName
```
public String getAliasBusinessName()
```
    See Also:
    
    alias__business_name_
  - setAliasBusinessName
```
public void setAliasBusinessName(String alias__business_name_)
```
    See Also:
    
    alias__business_name_
  - getPhysicalName
```
public String getPhysicalName()
```
    See Also:
    
    physical_name
  - setPhysicalName
```
public void setPhysicalName(String physical_name)
```
    See Also:
    
    physical_name
  - getTheType
```
public String getTheType()
```
    See Also:
    
    type
  - setTheType
```
public void setTheType(String type)
```
    See Also:
    
    type
  - getSubtypes
```
public ReferenceList getSubtypes()
```
    See Also:
    
    subtypes
  - setSubtypes
```
public void setSubtypes(ReferenceList subtypes)
```
    See Also:
    
    subtypes
  - getSupertypes
```
public ReferenceList getSupertypes()
```
    See Also:
    
    supertypes
  - setSupertypes
```
public void setSupertypes(ReferenceList supertypes)
```
    See Also:
    
    supertypes
  - getImportedFrom
```
public String getImportedFrom()
```
    See Also:
    
    imported_from
  - setImportedFrom
```
public void setImportedFrom(String imported_from)
```
    See Also:
    
    imported_from
  - getBlueprintElements
```
public ReferenceList getBlueprintElements()
```
    See Also:
    
    blueprint_elements
  - setBlueprintElements
```
public void setBlueprintElements(ReferenceList blueprint_elements)
```
    See Also:
    
    blueprint_elements
  - getInCollections
```
public ReferenceList getInCollections()
```
    See Also:
    
    in_collections
  - setInCollections
```
public void setInCollections(ReferenceList in_collections)
```
    See Also:
    
    in_collections
  - 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()
```
  - isLogicalEntity
```
public static Boolean isLogicalEntity(Object obj)
```

Class LogicalEntity

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

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

implemented_by_design_tables_or_views

implemented_by_database_tables_or_views

subject_areas

entity_attributes

logical_keys

logical_inversion_keys

logical_foreign_keys

alias__business_name_

physical_name

type

subtypes

supertypes

imported_from

blueprint_elements

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

LogicalEntity

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLogicalDataModel

setLogicalDataModel

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getImplementedByDesignTablesOrViews

setImplementedByDesignTablesOrViews

getImplementedByDatabaseTablesOrViews

setImplementedByDatabaseTablesOrViews

getSubjectAreas

setSubjectAreas

getEntityAttributes

setEntityAttributes

getLogicalKeys

setLogicalKeys

getLogicalInversionKeys

setLogicalInversionKeys

getLogicalForeignKeys

setLogicalForeignKeys

getAliasBusinessName

setAliasBusinessName

getPhysicalName

setPhysicalName

getTheType

setTheType