org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base

Class DesignForeignKey

java.lang.Object

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.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 created 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 ItemList<DataItem>	includedDatabaseColumns
protected String	longDescription
protected String	name
protected String	nativeId
protected Datagroup	ofDataCollection
protected ItemList<DataItem>	referencedByDesignColumn
protected String	shortDescription

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

_context, _id, _name, _type, _url, createdBy, createdOn, modifiedBy, modifiedOn, notes

Constructor Summary

Constructors

Constructor and Description
DesignForeignKey()

Method Summary

Modifier and Type	Method and Description
ItemList<DataItem>	getIncludedDatabaseColumns() Retrieve the included_database_columns property (displayed as 'Design Columns') of the object.
String	getLongDescription() Retrieve the long_description property (displayed as 'Long Description') of the object.
String	getNativeId() Retrieve the native_id property (displayed as 'Native ID') of the object.
Datagroup	getOfDataCollection() Retrieve the of_data_collection property (displayed as 'Of Data Collection') of the object.
ItemList<DataItem>	getReferencedByDesignColumn() Retrieve the referenced_by_design_column property (displayed as 'Parent Design Columns') of the object.
String	getShortDescription() Retrieve the short_description property (displayed as 'Short Description') of the object.
String	getTheName() Retrieve the name property (displayed as 'Name') of the object.
void	setIncludedDatabaseColumns(ItemList<DataItem> includedDatabaseColumns) Set the included_database_columns property (displayed as Design Columns) of the object.
void	setLongDescription(String longDescription) Set the long_description property (displayed as Long Description) of the object.
void	setNativeId(String nativeId) Set the native_id property (displayed as Native ID) of the object.
void	setOfDataCollection(Datagroup ofDataCollection) Set the of_data_collection property (displayed as Of Data Collection) of the object.
void	setReferencedByDesignColumn(ItemList<DataItem> referencedByDesignColumn) Set the referenced_by_design_column property (displayed as Parent Design Columns) of the object.
void	setShortDescription(String shortDescription) Set the short_description property (displayed as Short Description) of the object.
void	setTheName(String name) Set the name property (displayed as Name) of the object.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.Reference

areModificationDetailsPopulated, getContext, getCreatedBy, getCreatedOn, getId, getIdentity, getModifiedBy, getModifiedOn, getName, getNotes, getType, getUrl, isEmbeddedAsset, isFullyRetrieved, isIdentityPopulated, isSimpleType, isVirtualAsset, setContext, setCreatedBy, setCreatedOn, setFullyRetrieved, setId, setModifiedBy, setModifiedOn, setName, setNotes, setType, setUrl

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common.ObjectPrinter

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

includedDatabaseColumns

protected ItemList<DataItem> includedDatabaseColumns

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

ofDataCollection

protected Datagroup ofDataCollection

referencedByDesignColumn

protected ItemList<DataItem> referencedByDesignColumn

shortDescription

protected String shortDescription

Constructor Detail

DesignForeignKey

public DesignForeignKey()

Method Detail

getIncludedDatabaseColumns

public ItemList<DataItem> getIncludedDatabaseColumns()

Retrieve the included_database_columns property (displayed as 'Design Columns') of the object.

Returns:

ItemList<DataItem>

setIncludedDatabaseColumns

public void setIncludedDatabaseColumns(ItemList<DataItem> includedDatabaseColumns)

Set the included_database_columns property (displayed as Design Columns) of the object.

Parameters:

includedDatabaseColumns - the value to set

getLongDescription

public String getLongDescription()

Retrieve the long_description property (displayed as 'Long Description') of the object.

Returns:

String

setLongDescription

public void setLongDescription(String longDescription)

Set the long_description property (displayed as Long Description) of the object.

Parameters:

longDescription - the value to set

getTheName

public String getTheName()

Retrieve the name property (displayed as 'Name') of the object.

Returns:

String

setTheName

public void setTheName(String name)

Set the name property (displayed as Name) of the object.

Parameters:

name - the value to set

getNativeId

public String getNativeId()

Retrieve the native_id property (displayed as 'Native ID') of the object.

Returns:

String

setNativeId

public void setNativeId(String nativeId)

Set the native_id property (displayed as Native ID) of the object.

Parameters:

nativeId - the value to set

getOfDataCollection

public Datagroup getOfDataCollection()

Retrieve the of_data_collection property (displayed as 'Of Data Collection') of the object.

Returns:

Datagroup

setOfDataCollection

public void setOfDataCollection(Datagroup ofDataCollection)

Set the of_data_collection property (displayed as Of Data Collection) of the object.

Parameters:

ofDataCollection - the value to set

getReferencedByDesignColumn

public ItemList<DataItem> getReferencedByDesignColumn()

Retrieve the referenced_by_design_column property (displayed as 'Parent Design Columns') of the object.

Returns:

ItemList<DataItem>

setReferencedByDesignColumn

public void setReferencedByDesignColumn(ItemList<DataItem> referencedByDesignColumn)

Set the referenced_by_design_column property (displayed as Parent Design Columns) of the object.

Parameters:

referencedByDesignColumn - the value to set

getShortDescription

public String getShortDescription()

Retrieve the short_description property (displayed as 'Short Description') of the object.

Returns:

String

setShortDescription

public void setShortDescription(String shortDescription)

Set the short_description property (displayed as Short Description) of the object.

Parameters:

shortDescription - the value to set