GovernanceActionProcessProperties (Governance Engine OMAS API 2.10 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.governanceengine.properties.ReferenceableProperties
- - org.odpi.openmetadata.accessservices.governanceengine.properties.GovernanceActionProcessProperties

All Implemented Interfaces:

Serializable
```
public class GovernanceActionProcessProperties
extends ReferenceableProperties
```
Process properties defines the properties of a process. A process is a series of steps and decisions in operation in the organization. It is typically an automated process but may be performed by a person. Only set the implementationLanguage if the process is automated.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`GovernanceActionProcessProperties()` Default constructor
`GovernanceActionProcessProperties(GovernanceActionProcessProperties template)` Copy/clone Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Compare the values of the supplied object with those stored in the current object.
`String`	`getAbbreviation()` Return the abbreviation used for this technical element.
`String`	`getDescription()` Returns the stored description property for the technical element.
`String`	`getDisplayName()` Returns the stored display name property for the technical element.
`String`	`getFormula()` Return the description of the processing performed by this process.
`String`	`getImplementationLanguage()` Return the name of the programming language that this process is implemented in.
`String`	`getOriginBusinessCapabilityGUID()` Return the unique identifier of the business capability that originated this asset.
`String`	`getOriginOrganizationGUID()` Return the unique identifier for the organization that originated this asset.
`Map<String,String>`	`getOtherOriginValues()` Return the properties that characterize where this asset is from.
`String`	`getOwner()` Returns the name of the owner for this asset.
`OwnerCategory`	`getOwnerCategory()` Return the type of owner stored in the owner property.
`String`	`getSummary()` Return the short (1-2 sentence) description of the technical element.
`String`	`getTechnicalDescription()` Returns the stored technical description property for the asset.
`String`	`getTechnicalName()` Returns the stored name property for the asset.
`String`	`getUsage()` Return details of the expected usage of this technical element.
`List<String>`	`getZoneMembership()` Return the names of the zones that this asset is a member of.
`int`	`hashCode()` Return hash code for this object
`void`	`setAbbreviation(String abbreviation)` Set up the abbreviation used for this technical element.
`void`	`setDescription(String description)` Set up the stored description property for the technical element.
`void`	`setDisplayName(String displayName)` Set up the stored display name property for the technical element.
`void`	`setFormula(String formula)` Set up the the description of the processing performed by this process.
`void`	`setImplementationLanguage(String implementationLanguage)` Set up the name of the programming language that this process is implemented in.
`void`	`setOriginBusinessCapabilityGUID(String originBusinessCapabilityGUID)` Set up the unique identifier of the business capability that originated this asset.
`void`	`setOriginOrganizationGUID(String originOrganizationGUID)` Set up the unique identifier for the organization that originated this asset.
`void`	`setOtherOriginValues(Map<String,String> otherOriginValues)` Set up the properties that characterize where this asset is from.
`void`	`setOwner(String owner)` Set up the name of the owner for this asset.
`void`	`setOwnerCategory(OwnerCategory ownerType)` Set up the owner type for this asset.
`void`	`setSummary(String summary)` Set up the short (1-2 sentence) description of the technical element.
`void`	`setTechnicalDescription(String description)` Set up the stored technical description property associated with the asset.
`void`	`setTechnicalName(String technicalName)` Set up the stored name property for the asset.
`void`	`setUsage(String usage)` Set up details of the expected usage of this technical element.
`void`	`setZoneMembership(List<String> zoneMembership)` Set up the names of the zones that this asset is a member of.
`String`	`toString()` Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.governanceengine.properties.ReferenceableProperties
getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

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

- Constructor Detail
  - GovernanceActionProcessProperties
```
public GovernanceActionProcessProperties()
```
    Default constructor
  - GovernanceActionProcessProperties
```
public GovernanceActionProcessProperties(GovernanceActionProcessProperties template)
```
    Copy/clone Constructor
    
    Parameters:
    
    template - template object to copy.
- Method Detail
  - getDisplayName
```
public String getDisplayName()
```
    Returns the stored display name property for the technical element. If no display name is available then null is returned.
    
    Returns:
    
    String name
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Set up the stored display name property for the technical element.
    
    Parameters:
    
    displayName - String name
  - getSummary
```
public String getSummary()
```
    Return the short (1-2 sentence) description of the technical element.
    
    Returns:
    
    string text
  - setSummary
```
public void setSummary(String summary)
```
    Set up the short (1-2 sentence) description of the technical element.
    
    Parameters:
    
    summary - string text
  - getDescription
```
public String getDescription()
```
    Returns the stored description property for the technical element. If no description is provided then null is returned.
    
    Returns:
    
    String text
  - setDescription
```
public void setDescription(String description)
```
    Set up the stored description property for the technical element.
    
    Parameters:
    
    description - String text
  - getAbbreviation
```
public String getAbbreviation()
```
    Return the abbreviation used for this technical element.
    
    Returns:
    
    string text
  - setAbbreviation
```
public void setAbbreviation(String abbreviation)
```
    Set up the abbreviation used for this technical element.
    
    Parameters:
    
    abbreviation - string text
  - getUsage
```
public String getUsage()
```
    Return details of the expected usage of this technical element.
    
    Returns:
    
    string text
  - setUsage
```
public void setUsage(String usage)
```
    Set up details of the expected usage of this technical element.
    
    Parameters:
    
    usage - string text
  - getTechnicalName
```
public String getTechnicalName()
```
    Returns the stored name property for the asset. This is the technical name of the asset rather than the name that it is commonly known as. If no technical name is available then null is returned.
    
    Returns:
    
    String name
  - setTechnicalName
```
public void setTechnicalName(String technicalName)
```
    Set up the stored name property for the asset. This is the technical name of the asset rather than the name that it is commonly known as.
    
    Parameters:
    
    technicalName - String name
  - getTechnicalDescription
```
public String getTechnicalDescription()
```
    Returns the stored technical description property for the asset. If no technical description is provided then null is returned.
    
    Returns:
    
    String text
  - setTechnicalDescription
```
public void setTechnicalDescription(String description)
```
    Set up the stored technical description property associated with the asset.
    
    Parameters:
    
    description - String text
  - getOwner
```
public String getOwner()
```
    Returns the name of the owner for this asset.
    
    Returns:
    
    owner String
  - setOwner
```
public void setOwner(String owner)
```
    Set up the name of the owner for this asset.
    
    Parameters:
    
    owner - String name
  - getOwnerCategory
```
public OwnerCategory getOwnerCategory()
```
    Return the type of owner stored in the owner property.
    
    Returns:
    
    OwnerCategory enum
  - setOwnerCategory
```
public void setOwnerCategory(OwnerCategory ownerType)
```
    Set up the owner type for this asset.
    
    Parameters:
    
    ownerType - OwnerCategory enum
  - getZoneMembership
```
public List<String> getZoneMembership()
```
    Return the names of the zones that this asset is a member of.
    
    Returns:
    
    list of zone names
  - setZoneMembership
```
public void setZoneMembership(List<String> zoneMembership)
```
    Set up the names of the zones that this asset is a member of.
    
    Parameters:
    
    zoneMembership - list of zone names
  - getOriginOrganizationGUID
```
public String getOriginOrganizationGUID()
```
    Return the unique identifier for the organization that originated this asset.
    
    Returns:
    
    string guid
  - setOriginOrganizationGUID
```
public void setOriginOrganizationGUID(String originOrganizationGUID)
```
    Set up the unique identifier for the organization that originated this asset.
    
    Parameters:
    
    originOrganizationGUID - string guid
  - getOriginBusinessCapabilityGUID
```
public String getOriginBusinessCapabilityGUID()
```
    Return the unique identifier of the business capability that originated this asset.
    
    Returns:
    
    string guid
  - setOriginBusinessCapabilityGUID
```
public void setOriginBusinessCapabilityGUID(String originBusinessCapabilityGUID)
```
    Set up the unique identifier of the business capability that originated this asset.
    
    Parameters:
    
    originBusinessCapabilityGUID - string guid
  - getOtherOriginValues
```
public Map<String,String> getOtherOriginValues()
```
    Return the properties that characterize where this asset is from.
    
    Returns:
    
    map of name value pairs, all strings
  - setOtherOriginValues
```
public void setOtherOriginValues(Map<String,String> otherOriginValues)
```
    Set up the properties that characterize where this asset is from.
    
    Parameters:
    
    otherOriginValues - map of name value pairs, all strings
  - getFormula
```
public String getFormula()
```
    Return the description of the processing performed by this process.
    
    Returns:
    
    string description
  - setFormula
```
public void setFormula(String formula)
```
    Set up the the description of the processing performed by this process.
    
    Parameters:
    
    formula - string description
  - getImplementationLanguage
```
public String getImplementationLanguage()
```
    Return the name of the programming language that this process is implemented in.
    
    Returns:
    
    string name
  - setImplementationLanguage
```
public void setImplementationLanguage(String implementationLanguage)
```
    Set up the name of the programming language that this process is implemented in.
    
    Parameters:
    
    implementationLanguage - string name
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class ReferenceableProperties
    
    Returns:
    
    print out of variables in a JSON-style
  - equals
```
public boolean equals(Object objectToCompare)
```
    Compare the values of the supplied object with those stored in the current object.
    
    Overrides:
    
    equals in class ReferenceableProperties
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Return hash code for this object
    
    Overrides:
    
    hashCode in class ReferenceableProperties
    
    Returns:
    
    int hash code

Class GovernanceActionProcessProperties

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.accessservices.governanceengine.properties.ReferenceableProperties

Methods inherited from class java.lang.Object

Constructor Detail

GovernanceActionProcessProperties

GovernanceActionProcessProperties

Method Detail

getDisplayName

setDisplayName

getSummary

setSummary

getDescription

setDescription

getAbbreviation

setAbbreviation

getUsage

setUsage

getTechnicalName

setTechnicalName

getTechnicalDescription

setTechnicalDescription

getOwner

setOwner

getOwnerCategory

setOwnerCategory

getZoneMembership

setZoneMembership

getOriginOrganizationGUID

setOriginOrganizationGUID

getOriginBusinessCapabilityGUID

setOriginBusinessCapabilityGUID

getOtherOriginValues

setOtherOriginValues

getFormula

setFormula

getImplementationLanguage

setImplementationLanguage

toString

equals

hashCode