java.lang.Object
- org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetProperties, ConnectionProperties, ConnectorTypeProperties, DatabaseSchemaTypeProperties, EndpointProperties, SchemaElementProperties, SoftwareCapabilitiesProperties, ValidValueProperties, ValidValueSetProperties
```
public class ReferenceableProperties
extends Object
implements Serializable
```
Many open metadata entities are referenceable. It means that they have a qualified name and additional properties.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

ReferenceableProperties()
Default constructor

ReferenceableProperties(ReferenceableProperties template)
Copy/clone constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`Date`	`getEffectiveFrom()`	Return the date/time that this element is effective from (null means effective from the epoch).
`Date`	`getEffectiveTo()`	Return the date/time that element is effective to (null means that it is effective indefinitely into the future).
`Map<String,Object>`	`getExtendedProperties()`	Return the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
`String`	`getQualifiedName()`	Returns the stored qualified name property for the metadata entity.
`String`	`getTypeName()`	Return the name of the open metadata type for this metadata element.
`Map<String,String>`	`getVendorProperties()`	Return specific properties for the data manager vendor.
`int`	`hashCode()`	Return hash code based on properties.
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)`	Set up additional properties.
`void`	`setEffectiveFrom(Date effectiveFrom)`	Set up the date/time that this element is effective from (null means effective from the epoch).
`void`	`setEffectiveTo(Date effectiveTo)`	Set the date/time that element is effective to (null means that it is effective indefinitely into the future).
`void`	`setExtendedProperties(Map<String,Object> extendedProperties)`	Set up the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
`void`	`setQualifiedName(String qualifiedName)`	Set up the fully qualified name.
`void`	`setTypeName(String typeName)`	Set up the name of the open metadata type for this element.
`void`	`setVendorProperties(Map<String,String> vendorProperties)`	Set up specific properties for the data manager vendor.
`String`	`toString()`	Standard toString method.

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. Retrieves the values from the supplied template
    
    Parameters:
    
    template - element 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
  - 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
  - getEffectiveFrom
```
public Date getEffectiveFrom()
```
    Return the date/time that this element is effective from (null means effective from the epoch).
    
    Returns:
    
    date object
  - setEffectiveFrom
```
public void setEffectiveFrom(Date effectiveFrom)
```
    Set up the date/time that this element is effective from (null means effective from the epoch).
    
    Parameters:
    
    effectiveFrom - date object
  - getEffectiveTo
```
public Date getEffectiveTo()
```
    Return the date/time that element is effective to (null means that it is effective indefinitely into the future).
    
    Returns:
    
    date object
  - setEffectiveTo
```
public void setEffectiveTo(Date effectiveTo)
```
    Set the date/time that element is effective to (null means that it is effective indefinitely into the future).
    
    Parameters:
    
    effectiveTo - date object
  - getVendorProperties
```
public Map<String,String> getVendorProperties()
```
    Return specific properties for the data manager vendor.
    
    Returns:
    
    name value pairs
  - setVendorProperties
```
public void setVendorProperties(Map<String,String> vendorProperties)
```
    Set up specific properties for the data manager vendor.
    
    Parameters:
    
    vendorProperties - name value pairs
  - getTypeName
```
public String getTypeName()
```
    Return the name of the open metadata type for this metadata element.
    
    Returns:
    
    string name
  - setTypeName
```
public void setTypeName(String typeName)
```
    Set up the name of the open metadata type for this element.
    
    Parameters:
    
    typeName - string name
  - getExtendedProperties
```
public Map<String,Object> getExtendedProperties()
```
    Return the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
    
    Returns:
    
    property map
  - setExtendedProperties
```
public void setExtendedProperties(Map<String,Object> extendedProperties)
```
    Set up the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
    
    Parameters:
    
    extendedProperties - property map
  - 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()
```
    Return hash code based on properties.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int

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

Class ReferenceableProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReferenceableProperties

ReferenceableProperties

Method Detail

setQualifiedName

getQualifiedName

setAdditionalProperties

getAdditionalProperties

getEffectiveFrom

setEffectiveFrom

getEffectiveTo

setEffectiveTo

getVendorProperties

setVendorProperties

getTypeName

setTypeName

getExtendedProperties

setExtendedProperties

toString

equals

hashCode