org.odpi.openmetadata.frameworks.discovery.properties

Class DiscoveryServiceProperties

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

org.odpi.openmetadata.frameworks.discovery.properties.DiscoveryServiceProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RegisteredDiscoveryService

public class DiscoveryServiceProperties
extends PropertyBase

DiscoveryServiceProperties contains the definition of a discovery service. This definition can be associated with multiple discovery engines.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
DiscoveryServiceProperties() Default constructor
DiscoveryServiceProperties(DiscoveryServiceProperties template) Copy/clone constructor

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.
Map<String,String>	getAdditionalProperties() Return a copy of the additional properties.
Connection	getConnection() Return the connection used to create a instance of this discovery service.
String	getDescription() Returns the stored description property for the asset.
String	getDisplayName() Returns the stored display name property for the asset.
String	getOriginBusinessCapabilityGUID() Return the unique identifier of the business capability that originated this discovery service.
String	getOriginOrganizationGUID() Return the unique identifier for the organization that originated this discovery service.
Map<String,String>	getOtherOriginValues() Return the properties that characterize where this discovery service is from.
String	getOwner() Returns the name of the owner for this asset.
OwnerType	getOwnerType() Return the type of owner stored in the owner property.
String	getQualifiedName() Returns the stored qualified name property for the metadata entity.
List<String>	getZoneMembership() Return the names of the zones that this discovery service is a member of.
int	hashCode() Create a hash code for this element type.
void	setAdditionalProperties(Map<String,String> additionalProperties) Set up additional properties.
void	setConnection(Connection connection) Set up the connection used to create a instance of this discovery service.
void	setDescription(String description) Set up the stored description property associated with the asset.
void	setDisplayName(String displayName) Set up the stored display name property for the asset.
void	setOriginBusinessCapabilityGUID(String originBusinessCapabilityGUID) Set up the unique identifier of the business capability that originated this discovery service.
void	setOriginOrganizationGUID(String originOrganizationGUID) Set up the unique identifier for the organization that originated this discovery service.
void	setOtherOriginValues(Map<String,String> otherOriginValues) Set up the properties that characterize where this discovery service is from.
void	setOwner(String owner) Set up the name of the owner for this asset.
void	setOwnerType(OwnerType ownerType) Set up the owner type for this asset.
void	setQualifiedName(String qualifiedName) Set up the fully qualified name.
void	setZoneMembership(List<String> zoneMembership) Set up the names of the zones that this discovery service is a member of.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

getElementHeader, getExtendedProperties, getHeaderVersion, getTypeName, setElementHeader, setExtendedProperties, setHeaderVersion, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryServiceProperties

public DiscoveryServiceProperties()

Default constructor

DiscoveryServiceProperties

public DiscoveryServiceProperties(DiscoveryServiceProperties template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

setQualifiedName

public void setQualifiedName(String qualifiedName)

Set up the fully qualified name.

Parameters:

qualifiedName - String 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

getDisplayName

public String getDisplayName()

Returns the stored display name property for the asset. If no display name is available then null is returned.

Returns:

String name

setDisplayName

public void setDisplayName(String displayName)

Set up the stored display name property for the asset.

Parameters:

displayName - String name

getDescription

public String getDescription()

Returns the stored description property for the asset. If no description is provided then null is returned.

Returns:

description String text

setDescription

public void setDescription(String description)

Set up the stored description property associated with the asset.

Parameters:

description - String text

getOwner

public String getOwner()

Returns the name of the owner for this asset.

Returns:

owner String

setOwner

public void setOwner(String owner)

Set up the name of the owner for this asset.

Parameters:

owner - String name

getOwnerType

public OwnerType getOwnerType()

Return the type of owner stored in the owner property.

Returns:

OwnerCategory enum

setOwnerType

public void setOwnerType(OwnerType ownerType)

Set up the owner type for this asset.

Parameters:

ownerType - OwnerCategory enum

getZoneMembership

public List<String> getZoneMembership()

Return the names of the zones that this discovery service is a member of.

Returns:

list of zone names

setZoneMembership

public void setZoneMembership(List<String> zoneMembership)

Set up the names of the zones that this discovery service is a member of.

Parameters:

zoneMembership - list of zone names

getOriginOrganizationGUID

public String getOriginOrganizationGUID()

Return the unique identifier for the organization that originated this discovery service.

Returns:

string guid

setOriginOrganizationGUID

public void setOriginOrganizationGUID(String originOrganizationGUID)

Set up the unique identifier for the organization that originated this discovery service.

Parameters:

originOrganizationGUID - string guid

getOriginBusinessCapabilityGUID

public String getOriginBusinessCapabilityGUID()

Return the unique identifier of the business capability that originated this discovery service.

Returns:

string guid

setOriginBusinessCapabilityGUID

public void setOriginBusinessCapabilityGUID(String originBusinessCapabilityGUID)

Set up the unique identifier of the business capability that originated this discovery service.

Parameters:

originBusinessCapabilityGUID - string guid

getOtherOriginValues

public Map<String,String> getOtherOriginValues()

Return the properties that characterize where this discovery service is from.

Returns:

map of name value pairs, all strings

setOtherOriginValues

public void setOtherOriginValues(Map<String,String> otherOriginValues)

Set up the properties that characterize where this discovery service is from.

Parameters:

otherOriginValues - map of name value pairs, all strings

setAdditionalProperties

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

Set up additional properties.

Parameters:

additionalProperties - Additional properties object

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

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

Returns:

AdditionalProperties

getConnection

public Connection getConnection()

Return the connection used to create a instance of this discovery service.

Returns:

Connection object

setConnection

public void setConnection(Connection connection)

Set up the connection used to create a instance of this discovery service.

Parameters:

connection - connection object

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