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

Class ReferenceKey

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

public class ReferenceKey
extends Reference

POJO for the reference_key asset type in IGC, displayed as 'Reference 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 LogicalEntity	logicalEntity
protected String	longDescription
protected String	name
protected String	nativeId
protected String	physicalName
protected ItemList<EntityAttribute>	referencedByAttribute
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
ReferenceKey()

Method Summary

Modifier and Type	Method and Description
LogicalEntity	getLogicalEntity() Retrieve the logical_entity property (displayed as 'Logical Entity') 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.
String	getPhysicalName() Retrieve the physical_name property (displayed as 'Physical Name') of the object.
ItemList<EntityAttribute>	getReferencedByAttribute() Retrieve the referenced_by_attribute property (displayed as 'Parent Entity Attribute') 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	setLogicalEntity(LogicalEntity logicalEntity) Set the logical_entity property (displayed as Logical Entity) 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	setPhysicalName(String physicalName) Set the physical_name property (displayed as Physical Name) of the object.
void	setReferencedByAttribute(ItemList<EntityAttribute> referencedByAttribute) Set the referenced_by_attribute property (displayed as Parent Entity Attribute) 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

logicalEntity

protected LogicalEntity logicalEntity

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

physicalName

protected String physicalName

referencedByAttribute

protected ItemList<EntityAttribute> referencedByAttribute

shortDescription

protected String shortDescription

Constructor Detail

ReferenceKey

public ReferenceKey()

Method Detail

getLogicalEntity

public LogicalEntity getLogicalEntity()

Retrieve the logical_entity property (displayed as 'Logical Entity') of the object.

Returns:

LogicalEntity

setLogicalEntity

public void setLogicalEntity(LogicalEntity logicalEntity)

Set the logical_entity property (displayed as Logical Entity) of the object.

Parameters:

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

getPhysicalName

public String getPhysicalName()

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

Returns:

String

setPhysicalName

public void setPhysicalName(String physicalName)

Set the physical_name property (displayed as Physical Name) of the object.

Parameters:

physicalName - the value to set

getReferencedByAttribute

public ItemList<EntityAttribute> getReferencedByAttribute()

Retrieve the referenced_by_attribute property (displayed as 'Parent Entity Attribute') of the object.

Returns:

ItemList<EntityAttribute>

setReferencedByAttribute

public void setReferencedByAttribute(ItemList<EntityAttribute> referencedByAttribute)

Set the referenced_by_attribute property (displayed as Parent Entity Attribute) of the object.

Parameters:

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