InputParameter (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.InputParameter

```
public class InputParameter
extends Reference
```
POJO for the input_parameter asset type in IGC, displayed as 'Input Parameter' 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 ReferenceList`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' 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 ReferenceList`	`governed_by_rules` The `governed_by_rules` property, displayed as 'Governed by Rules' in the IGC UI.
`protected ReferenceList`	`impacted_by` The `impacted_by` property, displayed as 'Impacted by' in the IGC UI.
`protected ReferenceList`	`impacts_on` The `impacts_on` property, displayed as 'Impacts on' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected ReferenceList`	`in_collections` The `in_collections` property, displayed as 'In Collections' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected ReferenceList`	`method` The `method` property, displayed as 'Method' 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`	`reads_from__design_` The `reads_from_(design)` property, displayed as 'Reads from (Design)' in the IGC UI.
`protected ReferenceList`	`reads_from__operational_` The `reads_from_(operational)` property, displayed as 'Reads from (Operational)' in the IGC UI.
`protected ReferenceList`	`reads_from__static_` The `reads_from_(static)` property, displayed as 'Reads from (Static)' in the IGC UI.
`protected ReferenceList`	`reads_from__user_defined_` The `reads_from_(user_defined)` property, displayed as 'Reads from (User-Defined)' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected ReferenceList`	`writes_to__design_` The `writes_to_(design)` property, displayed as 'Writes to (Design)' in the IGC UI.
`protected ReferenceList`	`writes_to__operational_` The `writes_to_(operational)` property, displayed as 'Writes to (Operational)' in the IGC UI.
`protected ReferenceList`	`writes_to__static_` The `writes_to_(static)` property, displayed as 'Writes to (Static)' in the IGC UI.
`protected ReferenceList`	`writes_to__user_defined_` The `writes_to_(user_defined)` property, displayed as 'Writes to (User-Defined)' 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

InputParameter()

Constructors
Constructor and Description
`InputParameter()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAssignedToTerms()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImpactedBy()`
`ReferenceList`	`getImpactsOn()`
`ReferenceList`	`getImplementsRules()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`String`	`getLongDescription()`
`ReferenceList`	`getMethod()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`ReferenceList`	`getReadsFromDesign()`
`ReferenceList`	`getReadsFromOperational()`
`ReferenceList`	`getReadsFromStatic()`
`ReferenceList`	`getReadsFromUserDefined()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`ReferenceList`	`getWritesToDesign()`
`ReferenceList`	`getWritesToOperational()`
`ReferenceList`	`getWritesToStatic()`
`ReferenceList`	`getWritesToUserDefined()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isInputParameter(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImpactedBy(ReferenceList impacted_by)`
`void`	`setImpactsOn(ReferenceList impacts_on)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLongDescription(String long_description)`
`void`	`setMethod(ReferenceList method)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setReadsFromDesign(ReferenceList reads_from__design_)`
`void`	`setReadsFromOperational(ReferenceList reads_from__operational_)`
`void`	`setReadsFromStatic(ReferenceList reads_from__static_)`
`void`	`setReadsFromUserDefined(ReferenceList reads_from__user_defined_)`
`void`	`setShortDescription(String short_description)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setWritesToDesign(ReferenceList writes_to__design_)`
`void`	`setWritesToOperational(ReferenceList writes_to__operational_)`
`void`	`setWritesToStatic(ReferenceList writes_to__static_)`
`void`	`setWritesToUserDefined(ReferenceList writes_to__user_defined_)`

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.
  - method
```
protected ReferenceList method
```
    The method property, displayed as 'Method' in the IGC UI.
    
    Will be a ReferenceList of Method objects.
  - labels
```
protected ReferenceList labels
```
    The labels property, displayed as 'Labels' in the IGC UI.
    
    Will be a ReferenceList of Label objects.
  - stewards
```
protected ReferenceList stewards
```
    The stewards property, displayed as 'Stewards' in the IGC UI.
    
    Will be a ReferenceList of AsclSteward objects.
  - assigned_to_terms
```
protected ReferenceList assigned_to_terms
```
    The assigned_to_terms property, displayed as 'Assigned to Terms' in the IGC UI.
    
    Will be a ReferenceList of Term objects.
  - implements_rules
```
protected ReferenceList implements_rules
```
    The implements_rules property, displayed as 'Implements Rules' in the IGC UI.
    
    Will be a ReferenceList of InformationGovernanceRule objects.
  - governed_by_rules
```
protected ReferenceList governed_by_rules
```
    The governed_by_rules property, displayed as 'Governed by Rules' in the IGC UI.
    
    Will be a ReferenceList of InformationGovernanceRule objects.
  - reads_from__static_
```
protected ReferenceList reads_from__static_
```
    The reads_from_(static) property, displayed as 'Reads from (Static)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - writes_to__static_
```
protected ReferenceList writes_to__static_
```
    The writes_to_(static) property, displayed as 'Writes to (Static)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - reads_from__design_
```
protected ReferenceList reads_from__design_
```
    The reads_from_(design) property, displayed as 'Reads from (Design)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - writes_to__design_
```
protected ReferenceList writes_to__design_
```
    The writes_to_(design) property, displayed as 'Writes to (Design)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - reads_from__operational_
```
protected ReferenceList reads_from__operational_
```
    The reads_from_(operational) property, displayed as 'Reads from (Operational)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - writes_to__operational_
```
protected ReferenceList writes_to__operational_
```
    The writes_to_(operational) property, displayed as 'Writes to (Operational)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - reads_from__user_defined_
```
protected ReferenceList reads_from__user_defined_
```
    The reads_from_(user_defined) property, displayed as 'Reads from (User-Defined)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - writes_to__user_defined_
```
protected ReferenceList writes_to__user_defined_
```
    The writes_to_(user_defined) property, displayed as 'Writes to (User-Defined)' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - impacted_by
```
protected ReferenceList impacted_by
```
    The impacted_by property, displayed as 'Impacted by' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - impacts_on
```
protected ReferenceList impacts_on
```
    The impacts_on property, displayed as 'Impacts on' in the IGC UI.
    
    Will be a ReferenceList of InformationAsset objects.
  - in_collections
```
protected ReferenceList in_collections
```
    The in_collections property, displayed as 'In Collections' in the IGC UI.
    
    Will be a ReferenceList of Collection objects.
  - 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
  - InputParameter
```
public InputParameter()
```
- 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
  - getMethod
```
public ReferenceList getMethod()
```
    See Also:
    
    method
  - setMethod
```
public void setMethod(ReferenceList method)
```
    See Also:
    
    method
  - getLabels
```
public ReferenceList getLabels()
```
    See Also:
    
    labels
  - setLabels
```
public void setLabels(ReferenceList labels)
```
    See Also:
    
    labels
  - getStewards
```
public ReferenceList getStewards()
```
    See Also:
    
    stewards
  - setStewards
```
public void setStewards(ReferenceList stewards)
```
    See Also:
    
    stewards
  - getAssignedToTerms
```
public ReferenceList getAssignedToTerms()
```
    See Also:
    
    assigned_to_terms
  - setAssignedToTerms
```
public void setAssignedToTerms(ReferenceList assigned_to_terms)
```
    See Also:
    
    assigned_to_terms
  - getImplementsRules
```
public ReferenceList getImplementsRules()
```
    See Also:
    
    implements_rules
  - setImplementsRules
```
public void setImplementsRules(ReferenceList implements_rules)
```
    See Also:
    
    implements_rules
  - getGovernedByRules
```
public ReferenceList getGovernedByRules()
```
    See Also:
    
    governed_by_rules
  - setGovernedByRules
```
public void setGovernedByRules(ReferenceList governed_by_rules)
```
    See Also:
    
    governed_by_rules
  - getReadsFromStatic
```
public ReferenceList getReadsFromStatic()
```
    See Also:
    
    reads_from__static_
  - setReadsFromStatic
```
public void setReadsFromStatic(ReferenceList reads_from__static_)
```
    See Also:
    
    reads_from__static_
  - getWritesToStatic
```
public ReferenceList getWritesToStatic()
```
    See Also:
    
    writes_to__static_
  - setWritesToStatic
```
public void setWritesToStatic(ReferenceList writes_to__static_)
```
    See Also:
    
    writes_to__static_
  - getReadsFromDesign
```
public ReferenceList getReadsFromDesign()
```
    See Also:
    
    reads_from__design_
  - setReadsFromDesign
```
public void setReadsFromDesign(ReferenceList reads_from__design_)
```
    See Also:
    
    reads_from__design_
  - getWritesToDesign
```
public ReferenceList getWritesToDesign()
```
    See Also:
    
    writes_to__design_
  - setWritesToDesign
```
public void setWritesToDesign(ReferenceList writes_to__design_)
```
    See Also:
    
    writes_to__design_
  - getReadsFromOperational
```
public ReferenceList getReadsFromOperational()
```
    See Also:
    
    reads_from__operational_
  - setReadsFromOperational
```
public void setReadsFromOperational(ReferenceList reads_from__operational_)
```
    See Also:
    
    reads_from__operational_
  - getWritesToOperational
```
public ReferenceList getWritesToOperational()
```
    See Also:
    
    writes_to__operational_
  - setWritesToOperational
```
public void setWritesToOperational(ReferenceList writes_to__operational_)
```
    See Also:
    
    writes_to__operational_
  - getReadsFromUserDefined
```
public ReferenceList getReadsFromUserDefined()
```
    See Also:
    
    reads_from__user_defined_
  - setReadsFromUserDefined
```
public void setReadsFromUserDefined(ReferenceList reads_from__user_defined_)
```
    See Also:
    
    reads_from__user_defined_
  - getWritesToUserDefined
```
public ReferenceList getWritesToUserDefined()
```
    See Also:
    
    writes_to__user_defined_
  - setWritesToUserDefined
```
public void setWritesToUserDefined(ReferenceList writes_to__user_defined_)
```
    See Also:
    
    writes_to__user_defined_
  - getImpactedBy
```
public ReferenceList getImpactedBy()
```
    See Also:
    
    impacted_by
  - setImpactedBy
```
public void setImpactedBy(ReferenceList impacted_by)
```
    See Also:
    
    impacted_by
  - getImpactsOn
```
public ReferenceList getImpactsOn()
```
    See Also:
    
    impacts_on
  - setImpactsOn
```
public void setImpactsOn(ReferenceList impacts_on)
```
    See Also:
    
    impacts_on
  - getInCollections
```
public ReferenceList getInCollections()
```
    See Also:
    
    in_collections
  - setInCollections
```
public void setInCollections(ReferenceList in_collections)
```
    See Also:
    
    in_collections
  - 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()
```
  - isInputParameter
```
public static Boolean isInputParameter(Object obj)
```

Class InputParameter

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

method

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

reads_from__static_

writes_to__static_

reads_from__design_

writes_to__design_

reads_from__operational_

writes_to__operational_

reads_from__user_defined_

writes_to__user_defined_

impacted_by

impacts_on

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

InputParameter

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getMethod

setMethod

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getReadsFromStatic

setReadsFromStatic

getWritesToStatic

setWritesToStatic

getReadsFromDesign

setReadsFromDesign

getWritesToDesign

setWritesToDesign

getReadsFromOperational

setReadsFromOperational

getWritesToOperational

setWritesToOperational

getReadsFromUserDefined

setReadsFromUserDefined

getWritesToUserDefined

setWritesToUserDefined

getImpactedBy

setImpactedBy

getImpactsOn

setImpactsOn

getInCollections

setInCollections

getCreatedBy

setCreatedBy