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

Class Parameter

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

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

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

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

public class Parameter
extends DataItem

POJO for the parameter 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	connectionProperty Valid values are: CONNECTIONSTRING (displayed in the UI as 'CONNECTIONSTRING') USERNAME (displayed in the UI as 'USERNAME') PASSWORD (displayed in the UI as 'PASSWORD') PRIVATE (displayed in the UI as 'PRIVATE')
protected ItemList<Parameterval>	definesParameterVal
protected Boolean	isConnectionProperty
protected ParameterSet2	isParameterSet
protected Function	isReturnOfFunction
protected SharedContainer	ofContainerDef
protected Function	ofFunction
protected Jobdef	ofJobDef
protected ParameterSet2	ofParameterSet
protected StageType	ofStageType
protected Datagroup	ofStoredProcedure
protected String	usage Valid values are: DEFAULT (displayed in the UI as 'DEFAULT') IN (displayed in the UI as 'IN') OUT (displayed in the UI as 'OUT') INOUT (displayed in the UI as 'INOUT') RETURN (displayed in the UI as 'RETURN')

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.DataItem

allowNullValues, allowsEmptyValue, allowsNullValues, basedOn, calendar, dataItemDefinition, dataType, defaultValue, displaySize, fraction, hasDimension, isComputed, isSigned, itemKind, length, level, minimumLength, odbcType, position, type, unique, validatedByDataValues

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

blueprintElements, impactedBy, impactsOn, inCollections, nativeId, readByDesign, readByOperational, readByStatic, readByUserDefined, writtenByDesign, writtenByOperational, writtenByStatic, writtenByUserDefined

Fields inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

assignedToTerms, governedByRules, implementsRules, labels, longDescription, name, shortDescription, stewards

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

Method Summary

Modifier and Type	Method and Description
String	getConnectionProperty() Retrieve the connection_property property (displayed as 'Connection Property') of the object.
ItemList<Parameterval>	getDefinesParameterVal() Retrieve the defines_parameter_val property (displayed as 'Defines Parameter Val') of the object.
Boolean	getIsConnectionProperty() Retrieve the is_connection_property property (displayed as 'Is Connection Property') of the object.
ParameterSet2	getIsParameterSet() Retrieve the is_parameter_set property (displayed as 'Is Parameter Set') of the object.
Function	getIsReturnOfFunction() Retrieve the is_return_of_function property (displayed as 'Is Return Of Function') of the object.
SharedContainer	getOfContainerDef() Retrieve the of_container_def property (displayed as 'Of Container Def') of the object.
Function	getOfFunction() Retrieve the of_function property (displayed as 'Of Function') of the object.
Jobdef	getOfJobDef() Retrieve the of_job_def property (displayed as 'Of Job Def') of the object.
ParameterSet2	getOfParameterSet() Retrieve the of_parameter_set property (displayed as 'Of Parameter Set') of the object.
StageType	getOfStageType() Retrieve the of_stage_type property (displayed as 'Of Stage Type') of the object.
Datagroup	getOfStoredProcedure() Retrieve the of_stored_procedure property (displayed as 'Of Stored Procedure') of the object.
String	getUsage() Retrieve the usage property (displayed as 'Usage') of the object.
void	setConnectionProperty(String connectionProperty) Set the connection_property property (displayed as Connection Property) of the object.
void	setDefinesParameterVal(ItemList<Parameterval> definesParameterVal) Set the defines_parameter_val property (displayed as Defines Parameter Val) of the object.
void	setIsConnectionProperty(Boolean isConnectionProperty) Set the is_connection_property property (displayed as Is Connection Property) of the object.
void	setIsParameterSet(ParameterSet2 isParameterSet) Set the is_parameter_set property (displayed as Is Parameter Set) of the object.
void	setIsReturnOfFunction(Function isReturnOfFunction) Set the is_return_of_function property (displayed as Is Return Of Function) of the object.
void	setOfContainerDef(SharedContainer ofContainerDef) Set the of_container_def property (displayed as Of Container Def) of the object.
void	setOfFunction(Function ofFunction) Set the of_function property (displayed as Of Function) of the object.
void	setOfJobDef(Jobdef ofJobDef) Set the of_job_def property (displayed as Of Job Def) of the object.
void	setOfParameterSet(ParameterSet2 ofParameterSet) Set the of_parameter_set property (displayed as Of Parameter Set) of the object.
void	setOfStageType(StageType ofStageType) Set the of_stage_type property (displayed as Of Stage Type) of the object.
void	setOfStoredProcedure(Datagroup ofStoredProcedure) Set the of_stored_procedure property (displayed as Of Stored Procedure) of the object.
void	setUsage(String usage) Set the usage property (displayed as Usage) of the object.

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.DataItem

getAllowNullValues, getAllowsEmptyValue, getAllowsNullValues, getBasedOn, getCalendar, getDataItemDefinition, getDataType, getDefaultValue, getDisplaySize, getFraction, getHasDimension, getIsComputed, getIsSigned, getItemKind, getLength, getLevel, getMinimumLength, getOdbcType, getPosition, getTheType, getUnique, getValidatedByDataValues, setAllowNullValues, setAllowsEmptyValue, setAllowsNullValues, setBasedOn, setCalendar, setDataItemDefinition, setDataType, setDefaultValue, setDisplaySize, setFraction, setHasDimension, setIsComputed, setIsSigned, setItemKind, setLength, setLevel, setMinimumLength, setOdbcType, setPosition, setTheType, setUnique, setValidatedByDataValues

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.InformationAsset

getBlueprintElements, getImpactedBy, getImpactsOn, getInCollections, getNativeId, getReadByDesign, getReadByOperational, getReadByStatic, getReadByUserDefined, getWrittenByDesign, getWrittenByOperational, getWrittenByStatic, getWrittenByUserDefined, setBlueprintElements, setImpactedBy, setImpactsOn, setInCollections, setNativeId, setReadByDesign, setReadByOperational, setReadByStatic, setReadByUserDefined, setWrittenByDesign, setWrittenByOperational, setWrittenByStatic, setWrittenByUserDefined

Methods inherited from class org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.base.MainObject

getAssignedToTerms, getGovernedByRules, getImplementsRules, getLabels, getLongDescription, getShortDescription, getStewards, getTheName, setAssignedToTerms, setGovernedByRules, setImplementsRules, setLabels, setLongDescription, setShortDescription, setStewards, setTheName

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

connectionProperty

protected String connectionProperty

Valid values are:

• CONNECTIONSTRING (displayed in the UI as 'CONNECTIONSTRING')
• USERNAME (displayed in the UI as 'USERNAME')
• PASSWORD (displayed in the UI as 'PASSWORD')
• PRIVATE (displayed in the UI as 'PRIVATE')

definesParameterVal

protected ItemList<Parameterval> definesParameterVal

isConnectionProperty

protected Boolean isConnectionProperty

isParameterSet

protected ParameterSet2 isParameterSet

isReturnOfFunction

protected Function isReturnOfFunction

ofContainerDef

protected SharedContainer ofContainerDef

ofFunction

protected Function ofFunction

ofJobDef

protected Jobdef ofJobDef

ofParameterSet

protected ParameterSet2 ofParameterSet

ofStageType

protected StageType ofStageType

ofStoredProcedure

protected Datagroup ofStoredProcedure

usage

protected String usage

Valid values are:

• DEFAULT (displayed in the UI as 'DEFAULT')
• IN (displayed in the UI as 'IN')
• OUT (displayed in the UI as 'OUT')
• INOUT (displayed in the UI as 'INOUT')
• RETURN (displayed in the UI as 'RETURN')

Constructor Detail

Parameter

public Parameter()

Method Detail

getConnectionProperty

public String getConnectionProperty()

Retrieve the connection_property property (displayed as 'Connection Property') of the object.

Returns:

String

setConnectionProperty

public void setConnectionProperty(String connectionProperty)

Set the connection_property property (displayed as Connection Property) of the object.

Parameters:

connectionProperty - the value to set

getDefinesParameterVal

public ItemList<Parameterval> getDefinesParameterVal()

Retrieve the defines_parameter_val property (displayed as 'Defines Parameter Val') of the object.

Returns:

ItemList<Parameterval>

setDefinesParameterVal

public void setDefinesParameterVal(ItemList<Parameterval> definesParameterVal)

Set the defines_parameter_val property (displayed as Defines Parameter Val) of the object.

Parameters:

definesParameterVal - the value to set

getIsConnectionProperty

public Boolean getIsConnectionProperty()

Retrieve the is_connection_property property (displayed as 'Is Connection Property') of the object.

Returns:

Boolean

setIsConnectionProperty

public void setIsConnectionProperty(Boolean isConnectionProperty)

Set the is_connection_property property (displayed as Is Connection Property) of the object.

Parameters:

isConnectionProperty - the value to set

getIsParameterSet

public ParameterSet2 getIsParameterSet()

Retrieve the is_parameter_set property (displayed as 'Is Parameter Set') of the object.

Returns:

ParameterSet2

setIsParameterSet

public void setIsParameterSet(ParameterSet2 isParameterSet)

Set the is_parameter_set property (displayed as Is Parameter Set) of the object.

Parameters:

isParameterSet - the value to set

getIsReturnOfFunction

public Function getIsReturnOfFunction()

Retrieve the is_return_of_function property (displayed as 'Is Return Of Function') of the object.

Returns:

Function

setIsReturnOfFunction

public void setIsReturnOfFunction(Function isReturnOfFunction)

Set the is_return_of_function property (displayed as Is Return Of Function) of the object.

Parameters:

isReturnOfFunction - the value to set

getOfContainerDef

public SharedContainer getOfContainerDef()

Retrieve the of_container_def property (displayed as 'Of Container Def') of the object.

Returns:

SharedContainer

setOfContainerDef

public void setOfContainerDef(SharedContainer ofContainerDef)

Set the of_container_def property (displayed as Of Container Def) of the object.

Parameters:

ofContainerDef - the value to set

getOfFunction

public Function getOfFunction()

Retrieve the of_function property (displayed as 'Of Function') of the object.

Returns:

Function

setOfFunction

public void setOfFunction(Function ofFunction)

Set the of_function property (displayed as Of Function) of the object.

Parameters:

ofFunction - the value to set

getOfJobDef

public Jobdef getOfJobDef()

Retrieve the of_job_def property (displayed as 'Of Job Def') of the object.

Returns:

Jobdef

setOfJobDef

public void setOfJobDef(Jobdef ofJobDef)

Set the of_job_def property (displayed as Of Job Def) of the object.

Parameters:

ofJobDef - the value to set

getOfParameterSet

public ParameterSet2 getOfParameterSet()

Retrieve the of_parameter_set property (displayed as 'Of Parameter Set') of the object.

Returns:

ParameterSet2

setOfParameterSet

public void setOfParameterSet(ParameterSet2 ofParameterSet)

Set the of_parameter_set property (displayed as Of Parameter Set) of the object.

Parameters:

ofParameterSet - the value to set

getOfStageType

public StageType getOfStageType()

Retrieve the of_stage_type property (displayed as 'Of Stage Type') of the object.

Returns:

StageType

setOfStageType

public void setOfStageType(StageType ofStageType)

Set the of_stage_type property (displayed as Of Stage Type) of the object.

Parameters:

ofStageType - the value to set

getOfStoredProcedure

public Datagroup getOfStoredProcedure()

Retrieve the of_stored_procedure property (displayed as 'Of Stored Procedure') of the object.

Returns:

Datagroup

setOfStoredProcedure

public void setOfStoredProcedure(Datagroup ofStoredProcedure)

Set the of_stored_procedure property (displayed as Of Stored Procedure) of the object.

Parameters:

ofStoredProcedure - the value to set

getUsage

public String getUsage()

Retrieve the usage property (displayed as 'Usage') of the object.

Returns:

String

setUsage

public void setUsage(String usage)

Set the usage property (displayed as Usage) of the object.

Parameters:

usage - the value to set