Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class ExternalIdentifierProperties

java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.properties.ExternalIdentifierProperties
Direct Known Subclasses:
MetadataCorrelationProperties
public class ExternalIdentifierProperties extends Object
ExternalIdentifierProperties describes the properties used to pass information about an external identifier.

  • Constructor Details

    • ExternalIdentifierProperties

      public ExternalIdentifierProperties()
      Default constructor

    • ExternalIdentifierProperties

      public ExternalIdentifierProperties(ExternalIdentifierProperties template)
      Copy/clone constructor.
      Parameters:
      template - template object to copy.

  • Method Details

    • getSynchronizationDirection

      public PermittedSynchronization getSynchronizationDirection()
      Return details of the synchronization direction.
      Returns:
      enum

    • setSynchronizationDirection

      public void setSynchronizationDirection(PermittedSynchronization permittedSynchronization)
      Set up details of the synchronization direction.
      Parameters:
      permittedSynchronization - enum

    • getSynchronizationDescription

      public String getSynchronizationDescription()
      Return optional short description of the asset manager.
      Returns:
      string summary

    • setSynchronizationDescription

      public void setSynchronizationDescription(String synchronizationDescription)
      Set up optional short description of the asset manager.
      Parameters:
      synchronizationDescription - string summary

    • getExternalIdentifier

      public String getExternalIdentifier()
      Return the unique identifier used in the external asset manager for this element.
      Returns:
      string identifier

    • setExternalIdentifier

      public void setExternalIdentifier(String externalIdentifier)
      Set up the unique identifier used in the external asset manager for this element.
      Parameters:
      externalIdentifier - string identifier

    • getExternalIdentifierName

      public String getExternalIdentifierName()
      Return a short description of the external identifier (such as style or property name).
      Returns:
      string summary

    • setExternalIdentifierName

      public void setExternalIdentifierName(String externalIdentifierName)
      Set up a short description of the external identifier (such as style or property name).
      Parameters:
      externalIdentifierName - string summary

    • getExternalIdentifierUsage

      public String getExternalIdentifierUsage()
      Return a short description of how the external identifier is used.
      Returns:
      string description

    • setExternalIdentifierUsage

      public void setExternalIdentifierUsage(String externalIdentifierUsage)
      Set up a short description of how the external identifier is used.
      Parameters:
      externalIdentifierUsage - string description

    • getExternalIdentifierSource

      public String getExternalIdentifierSource()
      Return the component (connector/client) that created/maintained this external identifier and its relationship to the open metadata element(s).
      Returns:
      component name

    • setExternalIdentifierSource

      public void setExternalIdentifierSource(String externalIdentifierSource)
      Set up the component (connector/client) that created/maintained this external identifier and its relationship to the open metadata element(s).
      Parameters:
      externalIdentifierSource - component name

    • setKeyPattern

      public void setKeyPattern(KeyPattern keyPattern)
      Set up the key pattern used in the asset manager for the external identifier.
      Parameters:
      keyPattern - String name

    • getKeyPattern

      public KeyPattern getKeyPattern()
      Returns the key pattern used in the asset manager for the external identifier.
      Returns:
      String name

    • getExternalInstanceCreatedBy

      public String getExternalInstanceCreatedBy()
      Return the username of the person or process that created the instance in the external system.
      Returns:
      name

    • setExternalInstanceCreatedBy

      public void setExternalInstanceCreatedBy(String externalInstanceCreatedBy)
      Set up the username of the person or process that created the instance in the external system.
      Parameters:
      externalInstanceCreatedBy - name

    • getExternalInstanceCreationTime

      public Date getExternalInstanceCreationTime()
      Return the date/time when the instance in the external system was created.
      Returns:
      date

    • setExternalInstanceCreationTime

      public void setExternalInstanceCreationTime(Date externalInstanceCreationTime)
      Set up the date/time when the instance in the external system was created.
      Parameters:
      externalInstanceCreationTime - date

    • getExternalInstanceLastUpdatedBy

      public String getExternalInstanceLastUpdatedBy()
      Return the username of the person or process that last updated the instance in the external system.
      Returns:
      name

    • setExternalInstanceLastUpdatedBy

      public void setExternalInstanceLastUpdatedBy(String externalInstanceLastUpdatedBy)
      Set up the username of the person or process that last updated the instance in the external system.
      Parameters:
      externalInstanceLastUpdatedBy - name

    • getExternalInstanceLastUpdateTime

      public Date getExternalInstanceLastUpdateTime()
      Return the date/time that the instance in the external system was last updated.
      Returns:
      date

    • setExternalInstanceLastUpdateTime

      public void setExternalInstanceLastUpdateTime(Date externalInstanceLastUpdateTime)
      Set up the date/time that the instance in the external system was last updated.
      Parameters:
      externalInstanceLastUpdateTime - date

    • getExternalInstanceVersion

      public long getExternalInstanceVersion()
      Return the latest version of the element in the external system.
      Returns:
      long

    • setExternalInstanceVersion

      public void setExternalInstanceVersion(long externalInstanceVersion)
      Set up the latest version of the element in the external system.
      Parameters:
      externalInstanceVersion - long

    • getMappingProperties

      public Map<String,String> getMappingProperties()
      Return any additional properties to help with the mapping of the external identifier to open metadata elements.
      Returns:
      name-value pairs

    • setMappingProperties

      public void setMappingProperties(Map<String,String> mappingProperties)
      Set up any additional properties to help with the mapping of the external identifier to open metadata elements.
      Parameters:
      mappingProperties - name-value pairs

    • 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