org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.generated.v11501

Class LogicalForeignKey

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.LogicalForeignKey

public class LogicalForeignKey
extends Reference

POJO for the logical_foreign_key asset type in IGC, displayed as 'Logical Foreign Key' 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_entity_attributes The child_entity_attributes property, displayed as 'Child Entity Attributes' 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 Reference	logical_entity The logical_entity property, displayed as 'Logical Entity' 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 ReferenceList	referenced_by_entity_attributes The referenced_by_entity_attributes property, displayed as 'Parent Entity Attribute' 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
LogicalForeignKey()

Method Summary

Modifier and Type	Method and Description
static Boolean	canBeCreated()
static List<String>	getAllProperties()
ReferenceList	getChildEntityAttributes()
String	getCreatedBy()
Date	getCreatedOn()
static String	getIgcTypeDisplayName()
static String	getIgcTypeId()
Reference	getLogicalEntity()
String	getLongDescription()
String	getModifiedBy()
Date	getModifiedOn()
static List<String>	getNonRelationshipProperties()
static List<String>	getPagedRelationshipProperties()
String	getPhysicalName()
ReferenceList	getReferencedByEntityAttributes()
String	getShortDescription()
static List<String>	getStringProperties()
String	getTheName()
static Boolean	includesModificationDetails()
static Boolean	isLogicalForeignKey(Object obj)
void	setChildEntityAttributes(ReferenceList child_entity_attributes)
void	setCreatedBy(String created_by)
void	setCreatedOn(Date created_on)
void	setLogicalEntity(Reference logical_entity)
void	setLongDescription(String long_description)
void	setModifiedBy(String modified_by)
void	setModifiedOn(Date modified_on)
void	setPhysicalName(String physical_name)
void	setReferencedByEntityAttributes(ReferenceList referenced_by_entity_attributes)
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_entity

protected Reference logical_entity

The logical_entity property, displayed as 'Logical Entity' in the IGC UI.

Will be a single Reference to a LogicalEntity object.

physical_name

protected String physical_name

The physical_name property, displayed as 'Physical Name' in the IGC UI.

referenced_by_entity_attributes

protected ReferenceList referenced_by_entity_attributes

The referenced_by_entity_attributes property, displayed as 'Parent Entity Attribute' in the IGC UI.

Will be a ReferenceList of EntityAttribute objects.

child_entity_attributes

protected ReferenceList child_entity_attributes

The child_entity_attributes property, displayed as 'Child Entity Attributes' in the IGC UI.

Will be a ReferenceList of EntityAttribute 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

LogicalForeignKey

public LogicalForeignKey()

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

getLogicalEntity

public Reference getLogicalEntity()

See Also:

logical_entity

setLogicalEntity

public void setLogicalEntity(Reference logical_entity)

See Also:

logical_entity

getPhysicalName

public String getPhysicalName()

See Also:

physical_name

setPhysicalName

public void setPhysicalName(String physical_name)

See Also:

physical_name

getReferencedByEntityAttributes

public ReferenceList getReferencedByEntityAttributes()

See Also:

referenced_by_entity_attributes

setReferencedByEntityAttributes

public void setReferencedByEntityAttributes(ReferenceList referenced_by_entity_attributes)

See Also:

referenced_by_entity_attributes

getChildEntityAttributes

public ReferenceList getChildEntityAttributes()

See Also:

child_entity_attributes

setChildEntityAttributes

public void setChildEntityAttributes(ReferenceList child_entity_attributes)

See Also:

child_entity_attributes

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()

isLogicalForeignKey

public static Boolean isLogicalForeignKey(Object obj)