GovernanceActionTypeProperties (Governance Engine OMAS API 2.7 API)

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

All Implemented Interfaces:

Serializable
```
public class GovernanceActionTypeProperties
extends ReferenceableProperties
```
GovernanceActionTypeProperties provides a structure for carrying the properties for a governance action type.

See Also:

Serialized Form

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Equals method that returns true if containing properties are the same.
`String`	`getDescription()` Return the description of the governance action.
`String`	`getDisplayName()` Return the display name for the governance action.
`int`	`getDomainIdentifier()` Return the identifier of the governance domain that this action belongs to (0=ALL/ANY).
`String`	`getGovernanceEngineGUID()` Return the unique identifier of governance engine that is processing the governance action.
`String`	`getOwner()` Returns the name of the owner for this asset.
`OwnerCategory`	`getOwnerCategory()` Return the type of owner stored in the owner property.
`Map<String,String>`	`getRequestParameters()` Return the parameters to pass onto the governance service.
`String`	`getRequestType()` Return the request type associated with this governance action.
`List<String>`	`getSupportedGuards()` Return the list of guards provided by the previous governance service.
`int`	`hashCode()` Return hash code for this object
`void`	`setDescription(String description)` Set up the description of the governance action.
`void`	`setDisplayName(String displayName)` Set up the display name for the governance action.
`void`	`setDomainIdentifier(int domainIdentifier)` Set up the identifier of the governance domain that this action belongs to (0=ALL/ANY).
`void`	`setGovernanceEngineGUID(String governanceEngineGUID)` Set up the unique identifier of governance engine that is processing the governance action.
`void`	`setOwner(String owner)` Set up the name of the owner for this asset.
`void`	`setOwnerCategory(OwnerCategory ownerCategory)` Set up the owner type for this asset.
`void`	`setRequestParameters(Map<String,String> requestParameters)` Set up the parameters to pass onto the governance service.
`void`	`setRequestType(String requestType)` Set up the request type associated with this governance action, used to identify ths governance service to run.
`void`	`setSupportedGuards(List<String> supportedGuards)` Set up the list of guards provided by the previous governance service.
`String`	`toString()` JSON-style toString.

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
  - GovernanceActionTypeProperties
```
public GovernanceActionTypeProperties()
```
    Default constructor
  - GovernanceActionTypeProperties
```
public GovernanceActionTypeProperties(GovernanceActionTypeProperties template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getDomainIdentifier
```
public int getDomainIdentifier()
```
    Return the identifier of the governance domain that this action belongs to (0=ALL/ANY).
    
    Returns:
    
    int
  - setDomainIdentifier
```
public void setDomainIdentifier(int domainIdentifier)
```
    Set up the identifier of the governance domain that this action belongs to (0=ALL/ANY).
    
    Parameters:
    
    domainIdentifier - int
  - getDisplayName
```
public String getDisplayName()
```
    Return the display name for the governance action.
    
    Returns:
    
    string name
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Set up the display name for the governance action.
    
    Parameters:
    
    displayName - string name
  - getDescription
```
public String getDescription()
```
    Return the description of the governance action.
    
    Returns:
    
    string text
  - setDescription
```
public void setDescription(String description)
```
    Set up the description of the governance action.
    
    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 ownerCategory)
```
    Set up the owner type for this asset.
    
    Parameters:
    
    ownerCategory - OwnerCategory enum
  - getSupportedGuards
```
public List<String> getSupportedGuards()
```
    Return the list of guards provided by the previous governance service.
    
    Returns:
    
    list of guards
  - setSupportedGuards
```
public void setSupportedGuards(List<String> supportedGuards)
```
    Set up the list of guards provided by the previous governance service.
    
    Parameters:
    
    supportedGuards - list of guards
  - getGovernanceEngineGUID
```
public String getGovernanceEngineGUID()
```
    Return the unique identifier of governance engine that is processing the governance action.
    
    Returns:
    
    string guid
  - setGovernanceEngineGUID
```
public void setGovernanceEngineGUID(String governanceEngineGUID)
```
    Set up the unique identifier of governance engine that is processing the governance action.
    
    Parameters:
    
    governanceEngineGUID - string guid
  - getRequestType
```
public String getRequestType()
```
    Return the request type associated with this governance action.
    
    Returns:
    
    string name
  - setRequestType
```
public void setRequestType(String requestType)
```
    Set up the request type associated with this governance action, used to identify ths governance service to run.
    
    Parameters:
    
    requestType - string name
  - getRequestParameters
```
public Map<String,String> getRequestParameters()
```
    Return the parameters to pass onto the governance service.
    
    Returns:
    
    map of properties
  - setRequestParameters
```
public void setRequestParameters(Map<String,String> requestParameters)
```
    Set up the parameters to pass onto the governance service.
    
    Parameters:
    
    requestParameters - map of properties
  - toString
```
public String toString()
```
    JSON-style toString.
    
    Overrides:
    
    toString in class ReferenceableProperties
    
    Returns:
    
    list of properties and their values.
  - equals
```
public boolean equals(Object objectToCompare)
```
    Equals method that returns true if containing properties are the same.
    
    Overrides:
    
    equals in class ReferenceableProperties
    
    Parameters:
    
    objectToCompare - object to compare
    
    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 GovernanceActionTypeProperties

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

GovernanceActionTypeProperties

GovernanceActionTypeProperties

Method Detail

getDomainIdentifier

setDomainIdentifier

getDisplayName

setDisplayName

getDescription

setDescription

getOwner

setOwner

getOwnerCategory

setOwnerCategory

getSupportedGuards

setSupportedGuards

getGovernanceEngineGUID

setGovernanceEngineGUID

getRequestType

setRequestType

getRequestParameters

setRequestParameters

toString

equals

hashCode