org.odpi.openmetadata.frameworks.governanceaction.properties

Class ActionTargetElement

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.properties.ActionTargetElement

All Implemented Interfaces:

Serializable

public class ActionTargetElement
extends Object
implements Serializable

ActionTargetElement describes an element that a governance action service should process.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionTargetElement() Typical Constructor
ActionTargetElement(ActionTargetElement template) Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;

Method Summary

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	getActionTargetGUID() Return the unique identifier for this action target.
String	getActionTargetName() Return the name assigned to this action target.
Date	getCompletionDate() Return the date/time when the governance action service stopped processing this target element.
Date	getStartDate() Return the date/time when the governance action service started processing this target element.
GovernanceActionStatus	getStatus() Return the current status of the action target.
OpenMetadataElement	getTargetElement() Return details of the target element that the governance action service is to process.
int	hashCode() Create a hash code for this element type.
void	setActionTargetGUID(String actionTargetGUID) Set up the unique identifier for this action target.
void	setActionTargetName(String actionTargetName) Set up the name assigned to this action target.
void	setCompletionDate(Date completionDate) Set up the date/time when the governance action service stopped processing this target element.
void	setStartDate(Date startDate) Set up the date/time when the governance action service started processing this target element.
void	setStatus(GovernanceActionStatus status) Set up current status of the action target.
void	setTargetElement(OpenMetadataElement targetElement) Set up details of the target element that the governance action service is to process.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ActionTargetElement

public ActionTargetElement()

Typical Constructor

ActionTargetElement

public ActionTargetElement(ActionTargetElement template)

Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;

Parameters:

template - object being copied

Method Detail

getActionTargetName

public String getActionTargetName()

Return the name assigned to this action target. This name helps to guide the governance service in its processing of this action target.

Returns:

string name

setActionTargetName

public void setActionTargetName(String actionTargetName)

Set up the name assigned to this action target. This name helps to guide the governance service in its processing of this action target.

Parameters:

actionTargetName - string name

getActionTargetGUID

public String getActionTargetGUID()

Return the unique identifier for this action target.

Returns:

string identifier

setActionTargetGUID

public void setActionTargetGUID(String actionTargetGUID)

Set up the unique identifier for this action target.

Parameters:

actionTargetGUID - string identifier

getStatus

public GovernanceActionStatus getStatus()

Return the current status of the action target. The default value is the status is derived from the governance action service. However if it has to process many target elements, then these values can be used to show progress.

Returns:

status enum

setStatus

public void setStatus(GovernanceActionStatus status)

Set up current status of the action target. The default value is the status is derived from the governance action service. However if it has to process many target elements, then these values can be used to show progress.

Parameters:

status - enum

getStartDate

public Date getStartDate()

Return the date/time when the governance action service started processing this target element. By default, this value is derived from the startDate for the governance action service. However if it has to process many target elements, then these values can be used to show progress.

Returns:

date object

setStartDate

public void setStartDate(Date startDate)

Set up the date/time when the governance action service started processing this target element. By default, this value is derived from the startDate for the governance action service. However if it has to process many target elements, then these values can be used to show progress.

Parameters:

startDate - date object

getCompletionDate

public Date getCompletionDate()

Return the date/time when the governance action service stopped processing this target element. By default, this value is derived from the completionDate for the governance action service. However if it has to process many target elements, then these values can be used to show progress.

Returns:

date object

setCompletionDate

public void setCompletionDate(Date completionDate)

Set up the date/time when the governance action service stopped processing this target element. By default, this value is derived from the completionDate for the governance action service. However if it has to process many target elements, then these values can be used to show progress.

Parameters:

completionDate - date object

getTargetElement

public OpenMetadataElement getTargetElement()

Return details of the target element that the governance action service is to process.

Returns:

metadata element properties

setTargetElement

public void setTargetElement(OpenMetadataElement targetElement)

Set up details of the target element that the governance action service is to process.

Parameters:

targetElement - metadata element properties

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

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 Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class Object

Returns:

int hash code