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

```
public class Function
extends Reference
```
POJO for the function asset type in IGC, displayed as 'Function' 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`	`author` The `author` property, displayed as 'Author' in the IGC UI.
`protected ReferenceList`	`executed_by_function_call` The `executed_by_function_call` property, displayed as 'Executed By Function Call' in the IGC UI.
`protected String`	`external_name` The `external_name` property, displayed as 'External Name' 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`	`has_function_call` The `has_function_call` property, displayed as 'Has Function Call' in the IGC UI.
`protected ReferenceList`	`has_parameter_def` The `has_parameter_def` property, displayed as 'Has Parameter Def' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected Boolean`	`is_inline` The `is_inline` property, displayed as 'Is Inline' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected String`	`language` The `language` property, displayed as 'Language' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected String`	`module_name` The `module_name` property, displayed as 'Module Name' in the IGC UI.
`protected String`	`module_path` The `module_path` property, displayed as 'Module Path' in the IGC UI.
`protected String`	`name` The `name` property, displayed as 'Name' in the IGC UI.
`protected String`	`platform_type` The `platform_type` property, displayed as 'Platform Type' in the IGC UI.
`protected Reference`	`returns_parameter_def` The `returns_parameter_def` property, displayed as 'Returns Parameter Def' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected String`	`source_code` The `source_code` property, displayed as 'Source Code' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected String`	`vendor` The `vendor` property, displayed as 'Vendor' in the IGC UI.
`protected String`	`version` The `version` property, displayed as 'Version' 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

Function()

Constructors
Constructor and Description
`Function()`

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`	`getAuthor()`
`ReferenceList`	`getExecutedByFunctionCall()`
`String`	`getExternalName()`
`ReferenceList`	`getGovernedByRules()`
`ReferenceList`	`getHasFunctionCall()`
`ReferenceList`	`getHasParameterDef()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`Boolean`	`getIsInline()`
`ReferenceList`	`getLabels()`
`String`	`getLanguage()`
`String`	`getLongDescription()`
`String`	`getModuleName()`
`String`	`getModulePath()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getPlatformType()`
`Reference`	`getReturnsParameterDef()`
`String`	`getShortDescription()`
`String`	`getSourceCode()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`String`	`getVendor()`
`String`	`getVersion()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isFunction(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setAuthor(String author)`
`void`	`setExecutedByFunctionCall(ReferenceList executed_by_function_call)`
`void`	`setExternalName(String external_name)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setHasFunctionCall(ReferenceList has_function_call)`
`void`	`setHasParameterDef(ReferenceList has_parameter_def)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setIsInline(Boolean is_inline)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLanguage(String language)`
`void`	`setLongDescription(String long_description)`
`void`	`setModuleName(String module_name)`
`void`	`setModulePath(String module_path)`
`void`	`setPlatformType(String platform_type)`
`void`	`setReturnsParameterDef(Reference returns_parameter_def)`
`void`	`setShortDescription(String short_description)`
`void`	`setSourceCode(String source_code)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setVendor(String vendor)`
`void`	`setVersion(String version)`

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.
  - 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.
  - module_name
```
protected String module_name
```
    The module_name property, displayed as 'Module Name' in the IGC UI.
  - module_path
```
protected String module_path
```
    The module_path property, displayed as 'Module Path' in the IGC UI.
  - is_inline
```
protected Boolean is_inline
```
    The is_inline property, displayed as 'Is Inline' in the IGC UI.
  - source_code
```
protected String source_code
```
    The source_code property, displayed as 'Source Code' in the IGC UI.
  - vendor
```
protected String vendor
```
    The vendor property, displayed as 'Vendor' in the IGC UI.
  - has_function_call
```
protected ReferenceList has_function_call
```
    The has_function_call property, displayed as 'Has Function Call' in the IGC UI.
    
    Will be a ReferenceList of FunctionCall2 objects.
  - returns_parameter_def
```
protected Reference returns_parameter_def
```
    The returns_parameter_def property, displayed as 'Returns Parameter Def' in the IGC UI.
    
    Will be a single Reference to a Parameter object.
  - platform_type
```
protected String platform_type
```
    The platform_type property, displayed as 'Platform Type' in the IGC UI.
  - external_name
```
protected String external_name
```
    The external_name property, displayed as 'External Name' in the IGC UI.
  - language
```
protected String language
```
    The language property, displayed as 'Language' in the IGC UI.
  - version
```
protected String version
```
    The version property, displayed as 'Version' in the IGC UI.
  - executed_by_function_call
```
protected ReferenceList executed_by_function_call
```
    The executed_by_function_call property, displayed as 'Executed By Function Call' in the IGC UI.
    
    Will be a ReferenceList of FunctionCall2 objects.
  - has_parameter_def
```
protected ReferenceList has_parameter_def
```
    The has_parameter_def property, displayed as 'Has Parameter Def' in the IGC UI.
    
    Will be a ReferenceList of Parameter objects.
  - author
```
protected String author
```
    The author property, displayed as 'Author' in the IGC UI.
- Constructor Detail
  - Function
```
public Function()
```
- 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
  - 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
  - getModuleName
```
public String getModuleName()
```
    See Also:
    
    module_name
  - setModuleName
```
public void setModuleName(String module_name)
```
    See Also:
    
    module_name
  - getModulePath
```
public String getModulePath()
```
    See Also:
    
    module_path
  - setModulePath
```
public void setModulePath(String module_path)
```
    See Also:
    
    module_path
  - getIsInline
```
public Boolean getIsInline()
```
    See Also:
    
    is_inline
  - setIsInline
```
public void setIsInline(Boolean is_inline)
```
    See Also:
    
    is_inline
  - getSourceCode
```
public String getSourceCode()
```
    See Also:
    
    source_code
  - setSourceCode
```
public void setSourceCode(String source_code)
```
    See Also:
    
    source_code
  - getVendor
```
public String getVendor()
```
    See Also:
    
    vendor
  - setVendor
```
public void setVendor(String vendor)
```
    See Also:
    
    vendor
  - getHasFunctionCall
```
public ReferenceList getHasFunctionCall()
```
    See Also:
    
    has_function_call
  - setHasFunctionCall
```
public void setHasFunctionCall(ReferenceList has_function_call)
```
    See Also:
    
    has_function_call
  - getReturnsParameterDef
```
public Reference getReturnsParameterDef()
```
    See Also:
    
    returns_parameter_def
  - setReturnsParameterDef
```
public void setReturnsParameterDef(Reference returns_parameter_def)
```
    See Also:
    
    returns_parameter_def
  - getPlatformType
```
public String getPlatformType()
```
    See Also:
    
    platform_type
  - setPlatformType
```
public void setPlatformType(String platform_type)
```
    See Also:
    
    platform_type
  - getExternalName
```
public String getExternalName()
```
    See Also:
    
    external_name
  - setExternalName
```
public void setExternalName(String external_name)
```
    See Also:
    
    external_name
  - getLanguage
```
public String getLanguage()
```
    See Also:
    
    language
  - setLanguage
```
public void setLanguage(String language)
```
    See Also:
    
    language
  - getVersion
```
public String getVersion()
```
    See Also:
    
    version
  - setVersion
```
public void setVersion(String version)
```
    See Also:
    
    version
  - getExecutedByFunctionCall
```
public ReferenceList getExecutedByFunctionCall()
```
    See Also:
    
    executed_by_function_call
  - setExecutedByFunctionCall
```
public void setExecutedByFunctionCall(ReferenceList executed_by_function_call)
```
    See Also:
    
    executed_by_function_call
  - getHasParameterDef
```
public ReferenceList getHasParameterDef()
```
    See Also:
    
    has_parameter_def
  - setHasParameterDef
```
public void setHasParameterDef(ReferenceList has_parameter_def)
```
    See Also:
    
    has_parameter_def
  - getAuthor
```
public String getAuthor()
```
    See Also:
    
    author
  - setAuthor
```
public void setAuthor(String author)
```
    See Also:
    
    author
  - 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()
```
  - isFunction
```
public static Boolean isFunction(Object obj)
```

Class Function

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

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

module_name

module_path

is_inline

source_code

vendor

has_function_call

returns_parameter_def

platform_type

external_name

language

version

executed_by_function_call

has_parameter_def

author

Constructor Detail

Function

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getModuleName

setModuleName

getModulePath

setModulePath

getIsInline

setIsInline

getSourceCode

setSourceCode

getVendor

setVendor

getHasFunctionCall

setHasFunctionCall

getReturnsParameterDef

setReturnsParameterDef

getPlatformType

setPlatformType

getExternalName

setExternalName

getLanguage

setLanguage

getVersion

setVersion

getExecutedByFunctionCall

setExecutedByFunctionCall

getHasParameterDef

setHasParameterDef

getAuthor

setAuthor