Class ExternalIdentifierProperties
java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.properties.ExternalIdentifierProperties
- Direct Known Subclasses:
MetadataCorrelationProperties
ExternalIdentifierProperties describes the properties used to pass information about an external identifier.
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorCopy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the unique identifier used in the external asset manager for this element.Return a short description of the external identifier (such as style or property name).Return the component (connector/client) that created/maintained this external identifier and its relationship to the open metadata element(s).Return a short description of how the external identifier is used.Return the username of the person or process that created the instance in the external system.Return the date/time when the instance in the external system was created.Return the username of the person or process that last updated the instance in the external system.Return the date/time that the instance in the external system was last updated.long
Return the latest version of the element in the external system.Returns the key pattern used in the asset manager for the external identifier.Return any additional properties to help with the mapping of the external identifier to open metadata elements.Return optional short description of the asset manager.Return details of the synchronization direction.int
hashCode()
Return hash code based on properties.void
setExternalIdentifier
(String externalIdentifier) Set up the unique identifier used in the external asset manager for this element.void
setExternalIdentifierName
(String externalIdentifierName) Set up a short description of the external identifier (such as style or property name).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).void
setExternalIdentifierUsage
(String externalIdentifierUsage) Set up a short description of how the external identifier is used.void
setExternalInstanceCreatedBy
(String externalInstanceCreatedBy) Set up the username of the person or process that created the instance in the external system.void
setExternalInstanceCreationTime
(Date externalInstanceCreationTime) Set up the date/time when the instance in the external system was created.void
setExternalInstanceLastUpdatedBy
(String externalInstanceLastUpdatedBy) Set up the username of the person or process that last updated the instance in the external system.void
setExternalInstanceLastUpdateTime
(Date externalInstanceLastUpdateTime) Set up the date/time that the instance in the external system was last updated.void
setExternalInstanceVersion
(long externalInstanceVersion) Set up the latest version of the element in the external system.void
setKeyPattern
(KeyPattern keyPattern) Set up the key pattern used in the asset manager for the external identifier.void
setMappingProperties
(Map<String, String> mappingProperties) Set up any additional properties to help with the mapping of the external identifier to open metadata elements.void
setSynchronizationDescription
(String synchronizationDescription) Set up optional short description of the asset manager.void
setSynchronizationDirection
(PermittedSynchronization permittedSynchronization) Set up details of the synchronization direction.toString()
Standard toString method.
-
Constructor Details
-
ExternalIdentifierProperties
public ExternalIdentifierProperties()Default constructor -
ExternalIdentifierProperties
Copy/clone constructor.- Parameters:
template
- template object to copy.
-
-
Method Details
-
getSynchronizationDirection
Return details of the synchronization direction.- Returns:
- enum
-
setSynchronizationDirection
Set up details of the synchronization direction.- Parameters:
permittedSynchronization
- enum
-
getSynchronizationDescription
Return optional short description of the asset manager.- Returns:
- string summary
-
setSynchronizationDescription
Set up optional short description of the asset manager.- Parameters:
synchronizationDescription
- string summary
-
getExternalIdentifier
Return the unique identifier used in the external asset manager for this element.- Returns:
- string identifier
-
setExternalIdentifier
Set up the unique identifier used in the external asset manager for this element.- Parameters:
externalIdentifier
- string identifier
-
getExternalIdentifierName
Return a short description of the external identifier (such as style or property name).- Returns:
- string summary
-
setExternalIdentifierName
Set up a short description of the external identifier (such as style or property name).- Parameters:
externalIdentifierName
- string summary
-
getExternalIdentifierUsage
Return a short description of how the external identifier is used.- Returns:
- string description
-
setExternalIdentifierUsage
Set up a short description of how the external identifier is used.- Parameters:
externalIdentifierUsage
- string description
-
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
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
Set up the key pattern used in the asset manager for the external identifier.- Parameters:
keyPattern
- String name
-
getKeyPattern
Returns the key pattern used in the asset manager for the external identifier.- Returns:
- String name
-
getExternalInstanceCreatedBy
Return the username of the person or process that created the instance in the external system.- Returns:
- name
-
setExternalInstanceCreatedBy
Set up the username of the person or process that created the instance in the external system.- Parameters:
externalInstanceCreatedBy
- name
-
getExternalInstanceCreationTime
Return the date/time when the instance in the external system was created.- Returns:
- date
-
setExternalInstanceCreationTime
Set up the date/time when the instance in the external system was created.- Parameters:
externalInstanceCreationTime
- date
-
getExternalInstanceLastUpdatedBy
Return the username of the person or process that last updated the instance in the external system.- Returns:
- name
-
setExternalInstanceLastUpdatedBy
Set up the username of the person or process that last updated the instance in the external system.- Parameters:
externalInstanceLastUpdatedBy
- name
-
getExternalInstanceLastUpdateTime
Return the date/time that the instance in the external system was last updated.- Returns:
- date
-
setExternalInstanceLastUpdateTime
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
Return any additional properties to help with the mapping of the external identifier to open metadata elements.- Returns:
- name-value pairs
-
setMappingProperties
Set up any additional properties to help with the mapping of the external identifier to open metadata elements.- Parameters:
mappingProperties
- name-value pairs
-
toString
Standard toString method. -
equals
Compare the values of the supplied object with those stored in the current object. -
hashCode
public int hashCode()Return hash code based on properties.
-