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

Class Keycomponent

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

public class Keycomponent
extends Reference

POJO for the keycomponent asset type in IGC, displayed as 'KeyComponent' 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 MainObject	ofKey
protected DataItem	referencesDataField
protected Number	sequence
protected String	sortingOrder Valid values are: ASCENDING (displayed in the UI as 'ASCENDING') DESCENDING (displayed in the UI as 'DESCENDING') NONE (displayed in the UI as 'NONE')
protected DataItem	usesDataField

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

Method Summary

Modifier and Type	Method and Description
MainObject	getOfKey() Retrieve the of_key property (displayed as 'Of Key') of the object.
DataItem	getReferencesDataField() Retrieve the references_data_field property (displayed as 'References Data Field') of the object.
Number	getSequence() Retrieve the sequence property (displayed as 'Sequence') of the object.
String	getSortingOrder() Retrieve the sorting_order property (displayed as 'Sorting Order') of the object.
DataItem	getUsesDataField() Retrieve the uses_data_field property (displayed as 'Uses Data Field') of the object.
void	setOfKey(MainObject ofKey) Set the of_key property (displayed as Of Key) of the object.
void	setReferencesDataField(DataItem referencesDataField) Set the references_data_field property (displayed as References Data Field) of the object.
void	setSequence(Number sequence) Set the sequence property (displayed as Sequence) of the object.
void	setSortingOrder(String sortingOrder) Set the sorting_order property (displayed as Sorting Order) of the object.
void	setUsesDataField(DataItem usesDataField) Set the uses_data_field property (displayed as Uses Data Field) 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

ofKey

protected MainObject ofKey

referencesDataField

protected DataItem referencesDataField

sequence

protected Number sequence

sortingOrder

protected String sortingOrder

Valid values are:

• ASCENDING (displayed in the UI as 'ASCENDING')
• DESCENDING (displayed in the UI as 'DESCENDING')
• NONE (displayed in the UI as 'NONE')

usesDataField

protected DataItem usesDataField

Constructor Detail

Keycomponent

public Keycomponent()

Method Detail

getOfKey

public MainObject getOfKey()

Retrieve the of_key property (displayed as 'Of Key') of the object.

Returns:

MainObject

setOfKey

public void setOfKey(MainObject ofKey)

Set the of_key property (displayed as Of Key) of the object.

Parameters:

ofKey - the value to set

getReferencesDataField

public DataItem getReferencesDataField()

Retrieve the references_data_field property (displayed as 'References Data Field') of the object.

Returns:

DataItem

setReferencesDataField

public void setReferencesDataField(DataItem referencesDataField)

Set the references_data_field property (displayed as References Data Field) of the object.

Parameters:

referencesDataField - the value to set

getSequence

public Number getSequence()

Retrieve the sequence property (displayed as 'Sequence') of the object.

Returns:

Number

setSequence

public void setSequence(Number sequence)

Set the sequence property (displayed as Sequence) of the object.

Parameters:

sequence - the value to set

getSortingOrder

public String getSortingOrder()

Retrieve the sorting_order property (displayed as 'Sorting Order') of the object.

Returns:

String

setSortingOrder

public void setSortingOrder(String sortingOrder)

Set the sorting_order property (displayed as Sorting Order) of the object.

Parameters:

sortingOrder - the value to set

getUsesDataField

public DataItem getUsesDataField()

Retrieve the uses_data_field property (displayed as 'Uses Data Field') of the object.

Returns:

DataItem

setUsesDataField

public void setUsesDataField(DataItem usesDataField)

Set the uses_data_field property (displayed as Uses Data Field) of the object.

Parameters:

usesDataField - the value to set