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

Class ReferenceableProperties

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ActorProfileProperties, ContactMethodProperties, ExecutionPointProperties, ExternalReferenceProperties, GovernanceDomainProperties, GovernanceDomainSetProperties, GovernanceLevelIdentifierProperties, GovernanceLevelIdentifierSetProperties, GovernanceMetricProperties, GovernanceZoneProperties, SubjectAreaProperties, SupplementaryProperties, UserIdentityProperties

public abstract class ReferenceableProperties
extends Object
implements Serializable

ReferenceableProperties provides a structure for passing a referenceables' properties over the Java API.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Equals method that returns true if containing properties are the same.
Map<String,String>	getAdditionalProperties()	Return a copy of the additional properties.
Map<String,Object>	getExtendedProperties()	Return the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
String	getQualifiedName()	Returns the stored qualified name property for the metadata entity.
String	getTypeName()	Return the open metadata type name of this object - this is used to create a subtype of the referenceable.
int	hashCode()	Return hash code for this object
void	setAdditionalProperties(Map<String,String> additionalProperties)	Set up additional properties.
void	setExtendedProperties(Map<String,Object> extendedProperties)	Set up the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.
void	setQualifiedName(String qualifiedName)	Set up the fully qualified name.
void	setTypeName(String typeName)	Set up the open metadata type name of this object - this is used to create a subtype of the referenceable.
String	toString()	JSON-style toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceableProperties

public ReferenceableProperties()

Default constructor

ReferenceableProperties

public ReferenceableProperties(ReferenceableProperties template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getTypeName

public String getTypeName()

Return the open metadata type name of this object - this is used to create a subtype of the referenceable. Any properties associated with this subtype are passed as extended properties.

Returns:

string type name

setTypeName

public void setTypeName(String typeName)

Set up the open metadata type name of this object - this is used to create a subtype of the referenceable. Any properties associated with this subtype are passed as extended properties.

Parameters:

typeName - string type name

getQualifiedName

public String getQualifiedName()

Returns the stored qualified name property for the metadata entity. If no qualified name is available then the empty string is returned.

Returns:

qualifiedName

setQualifiedName

public void setQualifiedName(String qualifiedName)

Set up the fully qualified name.

Parameters:

qualifiedName - String name

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Return a copy of the additional properties. Null means no additional properties are available.

Returns:

AdditionalProperties

setAdditionalProperties

public void setAdditionalProperties(Map<String,String> additionalProperties)

Set up additional properties.

Parameters:

additionalProperties - Additional properties object

getExtendedProperties

public Map<String,Object> getExtendedProperties()

Return the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.

Returns:

map of properties

setExtendedProperties

public void setExtendedProperties(Map<String,Object> extendedProperties)

Set up the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.

Parameters:

extendedProperties - 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