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

Class CandidateKey

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

public class CandidateKey
extends Reference

POJO for the candidate_key asset type in IGC, displayed as 'Candidate 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 Datagroup	databaseTableView
protected ItemList<DatabaseColumn>	definedOnDatabaseColumns
protected String	longDescription
protected String	name
protected String	nativeId
protected Boolean	primaryKey
protected ItemList<ForeignKey>	referencedByForeignKeys
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
CandidateKey()

Method Summary

Modifier and Type	Method and Description
Datagroup	getDatabaseTableView() Retrieve the database_table_view property (displayed as 'Database Table View') of the object.
ItemList<DatabaseColumn>	getDefinedOnDatabaseColumns() Retrieve the defined_on_database_columns property (displayed as 'Defined on Database 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.
Boolean	getPrimaryKey() Retrieve the primary_key property (displayed as 'Primary Key') of the object.
ItemList<ForeignKey>	getReferencedByForeignKeys() Retrieve the referenced_by_foreign_keys property (displayed as 'Referenced by 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	setDatabaseTableView(Datagroup databaseTableView) Set the database_table_view property (displayed as Database Table View) of the object.
void	setDefinedOnDatabaseColumns(ItemList<DatabaseColumn> definedOnDatabaseColumns) Set the defined_on_database_columns property (displayed as Defined on Database 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	setPrimaryKey(Boolean primaryKey) Set the primary_key property (displayed as Primary Key) of the object.
void	setReferencedByForeignKeys(ItemList<ForeignKey> referencedByForeignKeys) Set the referenced_by_foreign_keys property (displayed as Referenced by 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

databaseTableView

protected Datagroup databaseTableView

definedOnDatabaseColumns

protected ItemList<DatabaseColumn> definedOnDatabaseColumns

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

primaryKey

protected Boolean primaryKey

referencedByForeignKeys

protected ItemList<ForeignKey> referencedByForeignKeys

shortDescription

protected String shortDescription

Constructor Detail

CandidateKey

public CandidateKey()

Method Detail

getDatabaseTableView

public Datagroup getDatabaseTableView()

Retrieve the database_table_view property (displayed as 'Database Table View') of the object.

Returns:

Datagroup

setDatabaseTableView

public void setDatabaseTableView(Datagroup databaseTableView)

Set the database_table_view property (displayed as Database Table View) of the object.

Parameters:

databaseTableView - the value to set

getDefinedOnDatabaseColumns

public ItemList<DatabaseColumn> getDefinedOnDatabaseColumns()

Retrieve the defined_on_database_columns property (displayed as 'Defined on Database Columns') of the object.

Returns:

ItemList<DatabaseColumn>

setDefinedOnDatabaseColumns

public void setDefinedOnDatabaseColumns(ItemList<DatabaseColumn> definedOnDatabaseColumns)

Set the defined_on_database_columns property (displayed as Defined on Database Columns) of the object.

Parameters:

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

getReferencedByForeignKeys

public ItemList<ForeignKey> getReferencedByForeignKeys()

Retrieve the referenced_by_foreign_keys property (displayed as 'Referenced by Foreign Keys') of the object.

Returns:

ItemList<ForeignKey>

setReferencedByForeignKeys

public void setReferencedByForeignKeys(ItemList<ForeignKey> referencedByForeignKeys)

Set the referenced_by_foreign_keys property (displayed as Referenced by Foreign Keys) of the object.

Parameters:

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