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

Class DsparameterSet

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

public class DsparameterSet
extends Reference

POJO for the dsparameter_set asset type in IGC, displayed as 'Parameter' 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 String	defaultValue
protected String	displayCaption
protected String	helpText
protected String	longDescription
protected String	name
protected String	nativeId
protected ParameterSet2	ofParameterSet
protected String	shortDescription
protected String	type Valid values are: UNUSED (displayed in the UI as 'UNUSED') ENCRYPTED (displayed in the UI as 'ENCRYPTED') PATHNAME (displayed in the UI as 'PATHNAME') STRINGLIST (displayed in the UI as 'STRINGLIST') INPUTCOL (displayed in the UI as 'INPUTCOL') OUTPUTCOL (displayed in the UI as 'OUTPUTCOL') NCHAR (displayed in the UI as 'NCHAR') PARAMETERSET (displayed in the UI as 'PARAMETERSET')

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

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue() Retrieve the default_value property (displayed as 'Default Value') of the object.
String	getDisplayCaption() Retrieve the display_caption property (displayed as 'Display Caption') of the object.
String	getHelpText() Retrieve the help_text property (displayed as 'Help Text') 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.
ParameterSet2	getOfParameterSet() Retrieve the of_parameter_set property (displayed as 'Context') 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.
String	getTheType() Retrieve the type property (displayed as 'Type') of the object.
void	setDefaultValue(String defaultValue) Set the default_value property (displayed as Default Value) of the object.
void	setDisplayCaption(String displayCaption) Set the display_caption property (displayed as Display Caption) of the object.
void	setHelpText(String helpText) Set the help_text property (displayed as Help Text) 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	setOfParameterSet(ParameterSet2 ofParameterSet) Set the of_parameter_set property (displayed as Context) 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.
void	setTheType(String type) Set the type property (displayed as Type) 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

defaultValue

protected String defaultValue

displayCaption

protected String displayCaption

helpText

protected String helpText

longDescription

protected String longDescription

name

protected String name

nativeId

protected String nativeId

ofParameterSet

protected ParameterSet2 ofParameterSet

shortDescription

protected String shortDescription

type

protected String type

Valid values are:

• UNUSED (displayed in the UI as 'UNUSED')
• ENCRYPTED (displayed in the UI as 'ENCRYPTED')
• PATHNAME (displayed in the UI as 'PATHNAME')
• STRINGLIST (displayed in the UI as 'STRINGLIST')
• INPUTCOL (displayed in the UI as 'INPUTCOL')
• OUTPUTCOL (displayed in the UI as 'OUTPUTCOL')
• NCHAR (displayed in the UI as 'NCHAR')
• PARAMETERSET (displayed in the UI as 'PARAMETERSET')

Constructor Detail

DsparameterSet

public DsparameterSet()

Method Detail

getDefaultValue

public String getDefaultValue()

Retrieve the default_value property (displayed as 'Default Value') of the object.

Returns:

String

setDefaultValue

public void setDefaultValue(String defaultValue)

Set the default_value property (displayed as Default Value) of the object.

Parameters:

defaultValue - the value to set

getDisplayCaption

public String getDisplayCaption()

Retrieve the display_caption property (displayed as 'Display Caption') of the object.

Returns:

String

setDisplayCaption

public void setDisplayCaption(String displayCaption)

Set the display_caption property (displayed as Display Caption) of the object.

Parameters:

displayCaption - the value to set

getHelpText

public String getHelpText()

Retrieve the help_text property (displayed as 'Help Text') of the object.

Returns:

String

setHelpText

public void setHelpText(String helpText)

Set the help_text property (displayed as Help Text) of the object.

Parameters:

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

getOfParameterSet

public ParameterSet2 getOfParameterSet()

Retrieve the of_parameter_set property (displayed as 'Context') of the object.

Returns:

ParameterSet2

setOfParameterSet

public void setOfParameterSet(ParameterSet2 ofParameterSet)

Set the of_parameter_set property (displayed as Context) of the object.

Parameters:

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

getTheType

public String getTheType()

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

Returns:

String

setTheType

public void setTheType(String type)

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

Parameters:

type - the value to set