Package org.odpi.openmetadata.accessservices.governanceprogram.properties

Class SubjectAreaProperties

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.governanceprogram.properties.SubjectAreaProperties

All Implemented Interfaces:

Serializable

public class SubjectAreaProperties
extends ReferenceableProperties

A subject area defines a group of definitions for governing assets related to a specific topic. The subject area definition defines how the assets related to the topic should be managed.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubjectAreaProperties()	Default constructor
SubjectAreaProperties(SubjectAreaProperties template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Return comparison result based on the content of the properties.
String	getDescription()	Return the description for the governance zone
String	getDisplayName()	Return the short name for the governance zone.
int	getDomainIdentifier()	Return the identifier of the governance domain that this subject area is managed by.
String	getScope()	Return the definition of the scope of this subject area
String	getSubjectAreaName()	Return the name of the subject area - this is added to the SubjectArea classification.
String	getUsage()	Return details of the usage of this subject area.
int	hashCode()	Return hash code for this object
void	setDescription(String description)	Set up the description of the governance zone
void	setDisplayName(String displayName)	Set up the short name for the governance zone.
void	setDomainIdentifier(int domainIdentifier)	Set up the identifier of the governance domain that this subject area is managed by.
void	setScope(String scope)	Set up the scope definition
void	setSubjectAreaName(String subjectAreaName)	Set up the name of the subject area - this is added to the SubjectArea classification.
void	setUsage(String usage)	Set up the details of the usage of this subject area.
String	toString()	JSON-style toString

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

getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Details

SubjectAreaProperties

public SubjectAreaProperties()

Default constructor

SubjectAreaProperties

public SubjectAreaProperties(SubjectAreaProperties template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getSubjectAreaName

public String getSubjectAreaName()

Return the name of the subject area - this is added to the SubjectArea classification.

Returns:

string name

setSubjectAreaName

public void setSubjectAreaName(String subjectAreaName)

Set up the name of the subject area - this is added to the SubjectArea classification.

Parameters:

subjectAreaName - string name

getDisplayName

public String getDisplayName()

Return the short name for the governance zone.

Returns:

string name

setDisplayName

public void setDisplayName(String displayName)

Set up the short name for the governance zone.

Parameters:

displayName - string name

getDescription

public String getDescription()

Return the description for the governance zone

Returns:

text

setDescription

public void setDescription(String description)

Set up the description of the governance zone

Parameters:

description - text

getUsage

public String getUsage()

Return details of the usage of this subject area.

Returns:

text

setUsage

public void setUsage(String usage)

Set up the details of the usage of this subject area.

Parameters:

usage - text

getScope

public String getScope()

Return the definition of the scope of this subject area

Returns:

scope definition

setScope

public void setScope(String scope)

Set up the scope definition

Parameters:

scope - string definition

getDomainIdentifier

public int getDomainIdentifier()

Return the identifier of the governance domain that this subject area is managed by.

Returns:

int identifier

setDomainIdentifier

public void setDomainIdentifier(int domainIdentifier)

Set up the identifier of the governance domain that this subject area is managed by.

Parameters:

domainIdentifier - int identifier

toString

public String toString()

JSON-style toString

Overrides:

toString in class ReferenceableProperties

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class ReferenceableProperties

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class ReferenceableProperties

Returns:

int hash code