org.odpi.openmetadata.accessservices.governanceprogram.properties

Class GovernanceDefinition

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.properties.GovernanceHeader

org.odpi.openmetadata.accessservices.governanceprogram.properties.GovernanceReferenceableHeader

org.odpi.openmetadata.accessservices.governanceprogram.properties.GovernanceDefinition

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CertificationType, GovernanceControl, GovernanceDriver, GovernancePolicy, LicenseType

public abstract class GovernanceDefinition
extends GovernanceReferenceableHeader

GovernanceDefinition provides the base class for many of the definitions that define the data strategy and governance program. It includes many of the common fields:

• GUID
• Type
• Document Id
• Title
• Summary
• Description
• Scope
• Status
• Priority
• Implications
• Outcomes
• AdditionalProperties

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GovernanceDefinition() Default Constructor
GovernanceDefinition(GovernanceDefinition template) Copy/clone Constructor

Method Summary

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 full description of the governance definition.
String	getDocumentId() Return the unique document Id for this governance definition.
List<GovernanceDefinitionMetric>	getGovernanceMetrics() Return the governance metrics that have been defined for this governance definition.
List<GovernanceZoneDefinition>	getGovernanceZones() Return the list of governance zones associates with this definition.
List<String>	getImplications() Return the list of implications for the organization that this governance definition brings.
List<String>	getOutcomes() Return the list of outcomes that resulted from implementing this governance definition.
String	getPriority() Return the priority of the governance definition.
String	getScope() Return the organizational scope that this governance definition applies to.
GovernanceDefinitionStatus	getStatus() Return the status of this governance definition.
String	getSummary() Return the summary for this governance definition.
void	setDescription(String description) Set up the full description of the governance definition.
void	setDocumentId(String documentId) Set up the document Id for this governance definition.
void	setGovernanceMetrics(List<GovernanceDefinitionMetric> governanceMetrics) Set up the governance metrics that have been defined for this governance definition.
void	setGovernanceZones(List<GovernanceZoneDefinition> governanceZones) Set up the list of governance zones associates with this definition.
void	setImplications(List<String> implications) Set up the list of implications for the organization that this governance definition brings.
void	setOutcomes(List<String> outcomes) Set up the list of outcomes that resulted from implementing this governance definition.
void	setPriority(String priority) Set up the priority of this governance definition.
void	setScope(String scope) Set up the organizational scope that this governance definition applies to.
void	setStatus(GovernanceDefinitionStatus status) Set up the status of this governance definition.
void	setSummary(String summary) Set up the summary of the governance definition.
String	toString() JSON-style toString.

Methods inherited from class org.odpi.openmetadata.accessservices.governanceprogram.properties.GovernanceReferenceableHeader

getAdditionalProperties, getExternalReferences, setAdditionalProperties, setExternalReferences

Methods inherited from class org.odpi.openmetadata.accessservices.governanceprogram.properties.GovernanceHeader

getGUID, getTitle, getType, hashCode, setGUID, setTitle, setType

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceDefinition

public GovernanceDefinition()

Default Constructor

GovernanceDefinition

public GovernanceDefinition(GovernanceDefinition template)

Copy/clone Constructor

Parameters:

template - object being copied

Method Detail

getDocumentId

public String getDocumentId()

Return the unique document Id for this governance definition. This is human-readable/memorable value.

Returns:

String identifier

setDocumentId

public void setDocumentId(String documentId)

Set up the document Id for this governance definition.

Parameters:

documentId - String identifier

getSummary

public String getSummary()

Return the summary for this governance definition. This should cover its essence. Think of it as the executive summary.

Returns:

String short description

setSummary

public void setSummary(String summary)

Set up the summary of the governance definition. This should cover its essence. Think of it as the executive summary.

Parameters:

summary - String description

getDescription

public String getDescription()

Return the full description of the governance definition.

Returns:

String description

setDescription

public void setDescription(String description)

Set up the full description of the governance definition.

Parameters:

description - String description

getScope

public String getScope()

Return the organizational scope that this governance definition applies to.

Returns:

String organization, department or team name

setScope

public void setScope(String scope)

Set up the organizational scope that this governance definition applies to.

Parameters:

scope - String organization, department or team name

getStatus

public GovernanceDefinitionStatus getStatus()

Return the status of this governance definition. The meaning of the different values are defined in the GovernanceDefinitionStatus enumeration.

Returns:

GovernanceDefinitionStatus enumeration

setStatus

public void setStatus(GovernanceDefinitionStatus status)

Set up the status of this governance definition. The meaning of the different values are defined in the GovernanceDefinitionStatus enumeration.

Parameters:

status - GovernanceDefinitionStatus enumeration

getPriority

public String getPriority()

Return the priority of the governance definition. This may be something like high, medium or low, or maybe a time frame or more detailed explanation.

Returns:

String priority

setPriority

public void setPriority(String priority)

Set up the priority of this governance definition. This may be something like high, medium or low, or maybe a time frame or more detailed explanation.

Parameters:

priority - String priority

getImplications

public List<String> getImplications()

Return the list of implications for the organization that this governance definition brings. This is often the first enumeration of the changes that that need to be implemented to bring the governance definition into effect.

Returns:

list of descriptions

setImplications

public void setImplications(List<String> implications)

Set up the list of implications for the organization that this governance definition brings. This is often the first enumeration of the changes that that need to be implemented to bring the governance definition into effect.

Parameters:

implications - list of descriptions

getOutcomes

public List<String> getOutcomes()

Return the list of outcomes that resulted from implementing this governance definition.

Returns:

list of outcome descriptions

setOutcomes

public void setOutcomes(List<String> outcomes)

Set up the list of outcomes that resulted from implementing this governance definition.

Parameters:

outcomes - list of descriptions of outcomes

getGovernanceMetrics

public List<GovernanceDefinitionMetric> getGovernanceMetrics()

Return the governance metrics that have been defined for this governance definition.

Returns:

metrics definition with rationale

setGovernanceMetrics

public void setGovernanceMetrics(List<GovernanceDefinitionMetric> governanceMetrics)

Set up the governance metrics that have been defined for this governance definition.

Parameters:

governanceMetrics - metrics definition with rationale

getGovernanceZones

public List<GovernanceZoneDefinition> getGovernanceZones()

Return the list of governance zones associates with this definition.

Returns:

list of governance zones

setGovernanceZones

public void setGovernanceZones(List<GovernanceZoneDefinition> governanceZones)

Set up the list of governance zones associates with this definition.

Parameters:

governanceZones - list of governance zones

toString

public String toString()

JSON-style toString.

Overrides:

toString in class GovernanceReferenceableHeader

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 GovernanceReferenceableHeader

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison