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

Class DesignForeignKey

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.v11701.DesignForeignKey

public class DesignForeignKey
extends Reference

POJO for the design_foreign_key asset type in IGC, displayed as 'Design 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 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	included_database_columns The included_database_columns property, displayed as 'Design Columns' 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 Reference	of_data_collection The of_data_collection property, displayed as 'Of Data Collection' in the IGC UI.
protected ReferenceList	referenced_by_design_column The referenced_by_design_column property, displayed as 'Parent Design Columns' 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
DesignForeignKey()

Method Summary

Modifier and Type	Method and Description
static Boolean	canBeCreated()
static List<String>	getAllProperties()
String	getCreatedBy()
Date	getCreatedOn()
static String	getIgcTypeDisplayName()
static String	getIgcTypeId()
ReferenceList	getIncludedDatabaseColumns()
String	getLongDescription()
String	getModifiedBy()
Date	getModifiedOn()
static List<String>	getNonRelationshipProperties()
Reference	getOfDataCollection()
static List<String>	getPagedRelationshipProperties()
ReferenceList	getReferencedByDesignColumn()
String	getShortDescription()
static List<String>	getStringProperties()
String	getTheName()
static Boolean	includesModificationDetails()
static Boolean	isDesignForeignKey(Object obj)
void	setCreatedBy(String created_by)
void	setCreatedOn(Date created_on)
void	setIncludedDatabaseColumns(ReferenceList included_database_columns)
void	setLongDescription(String long_description)
void	setModifiedBy(String modified_by)
void	setModifiedOn(Date modified_on)
void	setOfDataCollection(Reference of_data_collection)
void	setReferencedByDesignColumn(ReferenceList referenced_by_design_column)
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.

of_data_collection

protected Reference of_data_collection

The of_data_collection property, displayed as 'Of Data Collection' in the IGC UI.

Will be a single Reference to a Datagroup object.

included_database_columns

protected ReferenceList included_database_columns

The included_database_columns property, displayed as 'Design Columns' in the IGC UI.

Will be a ReferenceList of DataField objects.

referenced_by_design_column

protected ReferenceList referenced_by_design_column

The referenced_by_design_column property, displayed as 'Parent Design Columns' in the IGC UI.

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

DesignForeignKey

public DesignForeignKey()

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

getOfDataCollection

public Reference getOfDataCollection()

See Also:

of_data_collection

setOfDataCollection

public void setOfDataCollection(Reference of_data_collection)

See Also:

of_data_collection

getIncludedDatabaseColumns

public ReferenceList getIncludedDatabaseColumns()

See Also:

included_database_columns

setIncludedDatabaseColumns

public void setIncludedDatabaseColumns(ReferenceList included_database_columns)

See Also:

included_database_columns

getReferencedByDesignColumn

public ReferenceList getReferencedByDesignColumn()

See Also:

referenced_by_design_column

setReferencedByDesignColumn

public void setReferencedByDesignColumn(ReferenceList referenced_by_design_column)

See Also:

referenced_by_design_column

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

isDesignForeignKey

public static Boolean isDesignForeignKey(Object obj)