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

Class DesignKey

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

public class DesignKey
extends Reference

POJO for the design_key asset type in IGC, displayed as 'Design 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>	definedOnDesignColumns
protected Datagroup	designTableOrView
protected String	longDescription
protected String	name
protected String	nativeId
protected Boolean	primaryKey
protected ItemList<ForeignKey>	referencedByDesignForeignKeys
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
DesignKey()

Method Summary

Modifier and Type	Method and Description
ItemList<DataItem>	getDefinedOnDesignColumns() Retrieve the defined_on_design_columns property (displayed as 'Design Columns') of the object.
Datagroup	getDesignTableOrView() Retrieve the design_table_or_view property (displayed as 'Design Table or View') 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.
Boolean	getPrimaryKey() Retrieve the primary_key property (displayed as 'Primary Key') of the object.
ItemList<ForeignKey>	getReferencedByDesignForeignKeys() Retrieve the referenced_by_design_foreign_keys property (displayed as 'Child Design Foreign Keys') 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	setDefinedOnDesignColumns(ItemList<DataItem> definedOnDesignColumns) Set the defined_on_design_columns property (displayed as Design Columns) of the object.
void	setDesignTableOrView(Datagroup designTableOrView) Set the design_table_or_view property (displayed as Design Table or View) 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	setPrimaryKey(Boolean primaryKey) Set the primary_key property (displayed as Primary Key) of the object.
void	setReferencedByDesignForeignKeys(ItemList<ForeignKey> referencedByDesignForeignKeys) Set the referenced_by_design_foreign_keys property (displayed as Child Design Foreign Keys) 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

definedOnDesignColumns

protected ItemList<DataItem> definedOnDesignColumns

designTableOrView

protected Datagroup designTableOrView

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

primaryKey

protected Boolean primaryKey

referencedByDesignForeignKeys

protected ItemList<ForeignKey> referencedByDesignForeignKeys

shortDescription

protected String shortDescription

Constructor Detail

DesignKey

public DesignKey()

Method Detail

getDefinedOnDesignColumns

public ItemList<DataItem> getDefinedOnDesignColumns()

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

Returns:

ItemList<DataItem>

setDefinedOnDesignColumns

public void setDefinedOnDesignColumns(ItemList<DataItem> definedOnDesignColumns)

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

Parameters:

definedOnDesignColumns - the value to set

getDesignTableOrView

public Datagroup getDesignTableOrView()

Retrieve the design_table_or_view property (displayed as 'Design Table or View') of the object.

Returns:

Datagroup

setDesignTableOrView

public void setDesignTableOrView(Datagroup designTableOrView)

Set the design_table_or_view property (displayed as Design Table or View) of the object.

Parameters:

designTableOrView - 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

getPrimaryKey

public Boolean getPrimaryKey()

Retrieve the primary_key property (displayed as 'Primary Key') of the object.

Returns:

Boolean

setPrimaryKey

public void setPrimaryKey(Boolean primaryKey)

Set the primary_key property (displayed as Primary Key) of the object.

Parameters:

primaryKey - the value to set

getReferencedByDesignForeignKeys

public ItemList<ForeignKey> getReferencedByDesignForeignKeys()

Retrieve the referenced_by_design_foreign_keys property (displayed as 'Child Design Foreign Keys') of the object.

Returns:

ItemList<ForeignKey>

setReferencedByDesignForeignKeys

public void setReferencedByDesignForeignKeys(ItemList<ForeignKey> referencedByDesignForeignKeys)

Set the referenced_by_design_foreign_keys property (displayed as Child Design Foreign Keys) of the object.

Parameters:

referencedByDesignForeignKeys - 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