ParameterSetDefinition (IBM Information Governance Catalog REST API Client Library 1.0 API)

java.lang.Object
- org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
- - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
  - - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.generated.v11501.ParameterSetDefinition

```
public class ParameterSetDefinition
extends Reference
```
POJO for the parameter_set_definition asset type in IGC, displayed as 'Parameter Set Definition' in the IGC UI.

(this code has been generated 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 Reference`	`context` The `context` property, displayed as 'Context' in the IGC UI.
`protected String`	`created_by` The `created_by` property, displayed as 'Created By' in the IGC UI.
`protected Date`	`created_on` The `created_on` property, displayed as 'Created On' in the IGC UI.
`protected String`	`default_value` The `default_value` property, displayed as 'Default Value' in the IGC UI.
`protected String`	`display_caption` The `display_caption` property, displayed as 'Display Caption' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected String`	`modified_by` The `modified_by` property, displayed as 'Modified By' in the IGC UI.
`protected Date`	`modified_on` The `modified_on` property, displayed as 'Modified On' in the IGC UI.
`protected String`	`name` The `name` property, displayed as 'Name' in the IGC UI.
`protected ReferenceList`	`parameters` The `parameters` property, displayed as 'Parameters' in the IGC UI.
`protected ReferenceList`	`referenced_by_jobs` The `referenced_by_jobs` property, displayed as 'Referenced by Jobs' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected String`	`type` The `type` property, displayed as 'Type' in the IGC UI.

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
_context, _id, _name, _type, _url

Constructor Summary

Constructors
Constructor and Description

ParameterSetDefinition()

Constructors
Constructor and Description
`ParameterSetDefinition()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`String`	`getDefaultValue()`
`String`	`getDisplayCaption()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`ReferenceList`	`getParameters()`
`ReferenceList`	`getReferencedByJobs()`
`String`	`getShortDescription()`
`static List<String>`	`getStringProperties()`
`Reference`	`getTheContext()`
`String`	`getTheName()`
`String`	`getTheType()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isParameterSetDefinition(Object obj)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDefaultValue(String default_value)`
`void`	`setDisplayCaption(String display_caption)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setParameters(ReferenceList parameters)`
`void`	`setReferencedByJobs(ReferenceList referenced_by_jobs)`
`void`	`setShortDescription(String short_description)`
`void`	`setTheContext(Reference context)`
`void`	`setTheName(String name)`
`void`	`setTheType(String type)`

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
canAssetBeCreatedFromPOJO, getAllPropertiesFromPOJO, getAssetDetails, getAssetTypeForSearch, getAssetTypeFromPOJO, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getContext, getDisplayNameFromPOJO, getFieldByName, getFullAssetDetails, getId, getIdentity, getName, getNonRelationshipPropertiesFromPOJO, getPagedRelationalPropertiesFromPOJO, getPropertyByName, getStringPropertiesFromPOJO, getType, getUrl, hasModificationDetails, hasModificationDetails, hasProperty, isCreatableFromPOJO, isFullyRetrieved, isReference, isReference, isReferenceList, isReferenceList, isSimpleType, isSimpleType, populateContext, populateModificationDetails, setContext, setFullyRetrieved, setId, setName, setPropertyByName, setType, setUrl

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
getAllFields, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
    The name property, displayed as 'Name' in the IGC UI.
  - short_description
```
protected String short_description
```
    The short_description property, displayed as 'Short Description' in the IGC UI.
  - long_description
```
protected String long_description
```
    The long_description property, displayed as 'Long Description' in the IGC UI.
  - context
```
protected Reference context
```
    The context property, displayed as 'Context' in the IGC UI.
    
    Will be a single Reference to a TransformationProject object.
  - referenced_by_jobs
```
protected ReferenceList referenced_by_jobs
```
    The referenced_by_jobs property, displayed as 'Referenced by Jobs' in the IGC UI.
    
    Will be a ReferenceList of Jobdef objects.
  - parameters
```
protected ReferenceList parameters
```
    The parameters property, displayed as 'Parameters' in the IGC UI.
    
    Will be a ReferenceList of DsparameterSet objects.
  - type
```
protected String type
```
    The type property, displayed as 'Type' in the IGC UI.
    
    Can be one of the following values:
    - 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')
  - display_caption
```
protected String display_caption
```
    The display_caption property, displayed as 'Display Caption' in the IGC UI.
  - default_value
```
protected String default_value
```
    The default_value property, displayed as 'Default Value' in the IGC UI.
  - created_by
```
protected String created_by
```
    The created_by property, displayed as 'Created By' in the IGC UI.
  - created_on
```
protected Date created_on
```
    The created_on property, displayed as 'Created On' in the IGC UI.
  - modified_by
```
protected String modified_by
```
    The modified_by property, displayed as 'Modified By' in the IGC UI.
  - modified_on
```
protected Date modified_on
```
    The modified_on property, displayed as 'Modified On' in the IGC UI.
- Constructor Detail
  - ParameterSetDefinition
```
public ParameterSetDefinition()
```
- Method Detail
  - getIgcTypeId
```
public static String getIgcTypeId()
```
  - getIgcTypeDisplayName
```
public static String getIgcTypeDisplayName()
```
  - getTheName
```
public String getTheName()
```
    See Also:
    
    name
  - setTheName
```
public void setTheName(String name)
```
    See Also:
    
    name
  - getShortDescription
```
public String getShortDescription()
```
    See Also:
    
    short_description
  - setShortDescription
```
public void setShortDescription(String short_description)
```
    See Also:
    
    short_description
  - getLongDescription
```
public String getLongDescription()
```
    See Also:
    
    long_description
  - setLongDescription
```
public void setLongDescription(String long_description)
```
    See Also:
    
    long_description
  - getTheContext
```
public Reference getTheContext()
```
    See Also:
    
    context
  - setTheContext
```
public void setTheContext(Reference context)
```
    See Also:
    
    context
  - getReferencedByJobs
```
public ReferenceList getReferencedByJobs()
```
    See Also:
    
    referenced_by_jobs
  - setReferencedByJobs
```
public void setReferencedByJobs(ReferenceList referenced_by_jobs)
```
    See Also:
    
    referenced_by_jobs
  - getParameters
```
public ReferenceList getParameters()
```
    See Also:
    
    parameters
  - setParameters
```
public void setParameters(ReferenceList parameters)
```
    See Also:
    
    parameters
  - getTheType
```
public String getTheType()
```
    See Also:
    
    type
  - setTheType
```
public void setTheType(String type)
```
    See Also:
    
    type
  - getDisplayCaption
```
public String getDisplayCaption()
```
    See Also:
    
    display_caption
  - setDisplayCaption
```
public void setDisplayCaption(String display_caption)
```
    See Also:
    
    display_caption
  - getDefaultValue
```
public String getDefaultValue()
```
    See Also:
    
    default_value
  - setDefaultValue
```
public void setDefaultValue(String default_value)
```
    See Also:
    
    default_value
  - getCreatedBy
```
public String getCreatedBy()
```
    See Also:
    
    created_by
  - setCreatedBy
```
public void setCreatedBy(String created_by)
```
    See Also:
    
    created_by
  - getCreatedOn
```
public Date getCreatedOn()
```
    See Also:
    
    created_on
  - setCreatedOn
```
public void setCreatedOn(Date created_on)
```
    See Also:
    
    created_on
  - getModifiedBy
```
public String getModifiedBy()
```
    See Also:
    
    modified_by
  - setModifiedBy
```
public void setModifiedBy(String modified_by)
```
    See Also:
    
    modified_by
  - getModifiedOn
```
public Date getModifiedOn()
```
    See Also:
    
    modified_on
  - setModifiedOn
```
public void setModifiedOn(Date modified_on)
```
    See Also:
    
    modified_on
  - canBeCreated
```
public static Boolean canBeCreated()
```
  - includesModificationDetails
```
public static Boolean includesModificationDetails()
```
  - getNonRelationshipProperties
```
public static List<String> getNonRelationshipProperties()
```
  - getStringProperties
```
public static List<String> getStringProperties()
```
  - getPagedRelationshipProperties
```
public static List<String> getPagedRelationshipProperties()
```
  - getAllProperties
```
public static List<String> getAllProperties()
```
  - isParameterSetDefinition
```
public static Boolean isParameterSetDefinition(Object obj)
```

Class ParameterSetDefinition

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

Methods inherited from class java.lang.Object

Field Detail

name

short_description

long_description

context

referenced_by_jobs

parameters

type

display_caption

default_value

created_by

created_on

modified_by

modified_on

Constructor Detail

ParameterSetDefinition

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getTheContext

setTheContext

getReferencedByJobs

setReferencedByJobs

getParameters

setParameters

getTheType

setTheType

getDisplayCaption

setDisplayCaption

getDefaultValue

setDefaultValue

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

canBeCreated

includesModificationDetails

getNonRelationshipProperties

getStringProperties

getPagedRelationshipProperties

getAllProperties

isParameterSetDefinition