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

Class LogicalVariable

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

public class LogicalVariable
extends Reference

POJO for the logical_variable asset type in IGC, displayed as 'Logical Variable' 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<Term>	assignedToTerms
protected ItemList<InformationAsset>	binding
protected String	dataType Valid values are: INTEGER (displayed in the UI as 'INTEGER') FLOAT (displayed in the UI as 'FLOAT') NUMBER (displayed in the UI as 'NUMBER') FIXED_STRING (displayed in the UI as 'FIXED_STRING') VARIABLE_STRING (displayed in the UI as 'VARIABLE_STRING') STRING (displayed in the UI as 'STRING') DATE (displayed in the UI as 'DATE') TIME (displayed in the UI as 'TIME') DATETIME (displayed in the UI as 'DATETIME') ANY (displayed in the UI as 'ANY')
protected String	longDescription
protected String	name
protected String	nativeId
protected String	shortDescription
protected String	shortLongDescription
protected String	status Valid values are: CANDIDATE (displayed in the UI as 'CANDIDATE') ACCEPTED (displayed in the UI as 'ACCEPTED') STANDARD (displayed in the UI as 'STANDARD') DEPRECATED (displayed in the UI as 'DEPRECATED') DRAFT (displayed in the UI as 'DRAFT') IN_PROCESS (displayed in the UI as 'IN_PROCESS') REJECTED (displayed in the UI as 'REJECTED') SUGGESTED (displayed in the UI as 'SUGGESTED') ERROR (displayed in the UI as 'ERROR')
protected ItemList<AsclSteward>	stewards
protected String	type

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

Method Summary

Modifier and Type	Method and Description
ItemList<Term>	getAssignedToTerms() Retrieve the assigned_to_terms property (displayed as 'Assigned to Terms') of the object.
ItemList<InformationAsset>	getBinding() Retrieve the binding property (displayed as 'Binding') of the object.
String	getDataType() Retrieve the data_type property (displayed as 'Data Type') 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	getShortDescription() Retrieve the short_description property (displayed as 'Short Description') of the object.
String	getShortLongDescription() Retrieve the short_&_long_description property (displayed as 'Short & Long Description') of the object.
String	getStatus() Retrieve the status property (displayed as 'Status') of the object.
ItemList<AsclSteward>	getStewards() Retrieve the stewards property (displayed as 'Stewards') of the object.
String	getTheName() Retrieve the name property (displayed as 'Name') of the object.
String	getTheType() Retrieve the type property (displayed as 'Example') of the object.
void	setAssignedToTerms(ItemList<Term> assignedToTerms) Set the assigned_to_terms property (displayed as Assigned to Terms) of the object.
void	setBinding(ItemList<InformationAsset> binding) Set the binding property (displayed as Binding) of the object.
void	setDataType(String dataType) Set the data_type property (displayed as Data Type) 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	setShortDescription(String shortDescription) Set the short_description property (displayed as Short Description) of the object.
void	setShortLongDescription(String shortLongDescription) Set the short_&_long_description property (displayed as Short & Long Description) of the object.
void	setStatus(String status) Set the status property (displayed as Status) of the object.
void	setStewards(ItemList<AsclSteward> stewards) Set the stewards property (displayed as Stewards) of the object.
void	setTheName(String name) Set the name property (displayed as Name) of the object.
void	setTheType(String type) Set the type property (displayed as Example) 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

assignedToTerms

protected ItemList<Term> assignedToTerms

binding

protected ItemList<InformationAsset> binding

dataType

protected String dataType

Valid values are:

• INTEGER (displayed in the UI as 'INTEGER')
• FLOAT (displayed in the UI as 'FLOAT')
• NUMBER (displayed in the UI as 'NUMBER')
• FIXED_STRING (displayed in the UI as 'FIXED_STRING')
• VARIABLE_STRING (displayed in the UI as 'VARIABLE_STRING')
• STRING (displayed in the UI as 'STRING')
• DATE (displayed in the UI as 'DATE')
• TIME (displayed in the UI as 'TIME')
• DATETIME (displayed in the UI as 'DATETIME')
• ANY (displayed in the UI as 'ANY')

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

shortLongDescription

protected String shortLongDescription

shortDescription

protected String shortDescription

status

protected String status

Valid values are:

• CANDIDATE (displayed in the UI as 'CANDIDATE')
• ACCEPTED (displayed in the UI as 'ACCEPTED')
• STANDARD (displayed in the UI as 'STANDARD')
• DEPRECATED (displayed in the UI as 'DEPRECATED')
• DRAFT (displayed in the UI as 'DRAFT')
• IN_PROCESS (displayed in the UI as 'IN_PROCESS')
• REJECTED (displayed in the UI as 'REJECTED')
• SUGGESTED (displayed in the UI as 'SUGGESTED')
• ERROR (displayed in the UI as 'ERROR')

stewards

protected ItemList<AsclSteward> stewards

type

protected String type

Constructor Detail

LogicalVariable

public LogicalVariable()

Method Detail

getAssignedToTerms

public ItemList<Term> getAssignedToTerms()

Retrieve the assigned_to_terms property (displayed as 'Assigned to Terms') of the object.

Returns:

ItemList<Term>

setAssignedToTerms

public void setAssignedToTerms(ItemList<Term> assignedToTerms)

Set the assigned_to_terms property (displayed as Assigned to Terms) of the object.

Parameters:

assignedToTerms - the value to set

getBinding

public ItemList<InformationAsset> getBinding()

Retrieve the binding property (displayed as 'Binding') of the object.

Returns:

ItemList<InformationAsset>

setBinding

public void setBinding(ItemList<InformationAsset> binding)

Set the binding property (displayed as Binding) of the object.

Parameters:

binding - the value to set

getDataType

public String getDataType()

Retrieve the data_type property (displayed as 'Data Type') of the object.

Returns:

String

setDataType

public void setDataType(String dataType)

Set the data_type property (displayed as Data Type) of the object.

Parameters:

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

getShortLongDescription

public String getShortLongDescription()

Retrieve the short_&_long_description property (displayed as 'Short & Long Description') of the object.

Returns:

String

setShortLongDescription

public void setShortLongDescription(String shortLongDescription)

Set the short_&_long_description property (displayed as Short & Long Description) of the object.

Parameters:

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

getStatus

public String getStatus()

Retrieve the status property (displayed as 'Status') of the object.

Returns:

String

setStatus

public void setStatus(String status)

Set the status property (displayed as Status) of the object.

Parameters:

status - the value to set

getStewards

public ItemList<AsclSteward> getStewards()

Retrieve the stewards property (displayed as 'Stewards') of the object.

Returns:

ItemList<AsclSteward>

setStewards

public void setStewards(ItemList<AsclSteward> stewards)

Set the stewards property (displayed as Stewards) of the object.

Parameters:

stewards - the value to set

getTheType

public String getTheType()

Retrieve the type property (displayed as 'Example') of the object.

Returns:

String

setTheType

public void setTheType(String type)

Set the type property (displayed as Example) of the object.

Parameters:

type - the value to set