GovernanceActionProperties (Governance Engine OMAS API 2.6 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.governanceengine.properties.GovernanceActionProperties

All Implemented Interfaces:

Serializable
```
public class GovernanceActionProperties
extends Object
implements Serializable
```
GovernanceActionProperties provides a structure for carrying the properties for a governance action.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GovernanceActionProperties()
Default constructor

GovernanceActionProperties(GovernanceActionProperties template)
Copy/clone constructor

Constructors
Constructor and Description
`GovernanceActionProperties()` Default constructor
`GovernanceActionProperties(GovernanceActionProperties 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.
`GovernanceActionStatus`	`getActionStatus()` Return the current status of the governance action.
`List<ActionTargetElement>`	`getActionTargetElements()` Return the list of elements that the governance action will work on.
`Map<String,String>`	`getAdditionalProperties()` Return any additional properties.
`List<String>`	`getCompletionGuards()` Return the list of completion guards supplied by the governance service.
`Date`	`getCompletionTime()` Return the date/time that the governance service completed (or null if not yet completed).
`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`	`getProcessingEngineUserId()` Return the userId of the governance engine that is responsible for running the governance service for this governance action.
`String`	`getQualifiedName()` Return the qualified name for this new governance action.
`List<String>`	`getReceivedGuards()` Return the list of guards provided by the previous governance service.
`Map<String,String>`	`getRequestProperties()` Return the parameters to pass onto the governance service.
`List<RequestSourceElement>`	`getRequestSourceElements()` Return the list of elements that triggered this request.
`String`	`getRequestType()` Return the request type associated with this governance action.
`Date`	`getStartTime()` Return the time that this governance action should start (null means as soon as possible).
`int`	`hashCode()` Return hash code for this object
`void`	`setActionStatus(GovernanceActionStatus actionStatus)` Set up the current status of the governance action.
`void`	`setActionTargetElements(List<ActionTargetElement> actionTargetElements)` Set up the list of elements that the governance action will work on.
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)` Set up any additional properties.
`void`	`setCompletionGuards(List<String> completionGuards)` Set up the list of completion guards supplied by the governance service.
`void`	`setCompletionTime(Date completionTime)` Set up the date/time that the governance service completed (or null if not yet completed).
`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`	`setProcessingEngineUserId(String processingEngineUserId)` Set up the userId of the governance engine that is responsible for running the governance service for this governance action.
`void`	`setQualifiedName(String qualifiedName)` Set up the qualified name of this new governance action.
`void`	`setReceivedGuards(List<String> receivedGuards)` Set up the list of guards provided by the previous governance service.
`void`	`setRequestProperties(Map<String,String> requestProperties)` Set up the parameters to pass onto the governance service.
`void`	`setRequestSourceElements(List<RequestSourceElement> requestSourceElements)` Set up the list of elements that triggered this request.
`void`	`setRequestType(String requestType)` Set up the request type associated with this governance action, used to identify ths governance service to run.
`void`	`setStartTime(Date startTime)` Set up the time that this governance action should start (null means as soon as possible).
`String`	`toString()` JSON-style toString.

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

- Constructor Detail
  - GovernanceActionProperties
```
public GovernanceActionProperties()
```
    Default constructor
  - GovernanceActionProperties
```
public GovernanceActionProperties(GovernanceActionProperties template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getQualifiedName
```
public String getQualifiedName()
```
    Return the qualified name for this new governance action.
    
    Returns:
    
    string name
  - setQualifiedName
```
public void setQualifiedName(String qualifiedName)
```
    Set up the qualified name of this new governance action.
    
    Parameters:
    
    qualifiedName - string name
  - 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
  - getReceivedGuards
```
public List<String> getReceivedGuards()
```
    Return the list of guards provided by the previous governance service.
    
    Returns:
    
    list of guards
  - setReceivedGuards
```
public void setReceivedGuards(List<String> receivedGuards)
```
    Set up the list of guards provided by the previous governance service.
    
    Parameters:
    
    receivedGuards - 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
  - getActionStatus
```
public GovernanceActionStatus getActionStatus()
```
    Return the current status of the governance action.
    
    Returns:
    
    status enum
  - setActionStatus
```
public void setActionStatus(GovernanceActionStatus actionStatus)
```
    Set up the current status of the governance action.
    
    Parameters:
    
    actionStatus - status enum
  - getProcessingEngineUserId
```
public String getProcessingEngineUserId()
```
    Return the userId of the governance engine that is responsible for running the governance service for this governance action.
    
    Returns:
    
    string userId
  - setProcessingEngineUserId
```
public void setProcessingEngineUserId(String processingEngineUserId)
```
    Set up the userId of the governance engine that is responsible for running the governance service for this governance action.
    
    Parameters:
    
    processingEngineUserId - string userId
  - getRequestSourceElements
```
public List<RequestSourceElement> getRequestSourceElements()
```
    Return the list of elements that triggered this request.
    
    Returns:
    
    list of elements
  - setRequestSourceElements
```
public void setRequestSourceElements(List<RequestSourceElement> requestSourceElements)
```
    Set up the list of elements that triggered this request.
    
    Parameters:
    
    requestSourceElements - list of elements
  - getActionTargetElements
```
public List<ActionTargetElement> getActionTargetElements()
```
    Return the list of elements that the governance action will work on.
    
    Returns:
    
    list of elements
  - setActionTargetElements
```
public void setActionTargetElements(List<ActionTargetElement> actionTargetElements)
```
    Set up the list of elements that the governance action will work on.
    
    Parameters:
    
    actionTargetElements - list of elements
  - getStartTime
```
public Date getStartTime()
```
    Return the time that this governance action should start (null means as soon as possible).
    
    Returns:
    
    date object
  - setStartTime
```
public void setStartTime(Date startTime)
```
    Set up the time that this governance action should start (null means as soon as possible).
    
    Parameters:
    
    startTime - date object
  - 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
  - getRequestProperties
```
public Map<String,String> getRequestProperties()
```
    Return the parameters to pass onto the governance service.
    
    Returns:
    
    map of properties
  - setRequestProperties
```
public void setRequestProperties(Map<String,String> requestProperties)
```
    Set up the parameters to pass onto the governance service.
    
    Parameters:
    
    requestProperties - map of properties
  - getCompletionTime
```
public Date getCompletionTime()
```
    Return the date/time that the governance service completed (or null if not yet completed).
    
    Returns:
    
    date object
  - setCompletionTime
```
public void setCompletionTime(Date completionTime)
```
    Set up the date/time that the governance service completed (or null if not yet completed).
    
    Parameters:
    
    completionTime - date object
  - getCompletionGuards
```
public List<String> getCompletionGuards()
```
    Return the list of completion guards supplied by the governance service.
    
    Returns:
    
    list of guards
  - setCompletionGuards
```
public void setCompletionGuards(List<String> completionGuards)
```
    Set up the list of completion guards supplied by the governance service.
    
    Parameters:
    
    completionGuards - list of guards
  - getAdditionalProperties
```
public Map<String,String> getAdditionalProperties()
```
    Return any additional properties.
    
    Returns:
    
    map of properties
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,String> additionalProperties)
```
    Set up any additional properties.
    
    Parameters:
    
    additionalProperties - map of properties
  - toString
```
public String toString()
```
    JSON-style toString.
    
    Overrides:
    
    toString in class Object
    
    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 Object
    
    Parameters:
    
    objectToCompare - object to compare
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Return hash code for this object
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int hash code

Class GovernanceActionProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GovernanceActionProperties

GovernanceActionProperties

Method Detail

getQualifiedName

setQualifiedName

getDomainIdentifier

setDomainIdentifier

getDisplayName

setDisplayName

getDescription

setDescription

getReceivedGuards

setReceivedGuards

getGovernanceEngineGUID

setGovernanceEngineGUID

getActionStatus

setActionStatus

getProcessingEngineUserId

setProcessingEngineUserId

getRequestSourceElements

setRequestSourceElements

getActionTargetElements

setActionTargetElements

getStartTime

setStartTime

getRequestType

setRequestType

getRequestProperties

setRequestProperties

getCompletionTime

setCompletionTime

getCompletionGuards

setCompletionGuards

getAdditionalProperties

setAdditionalProperties

toString

equals

hashCode