Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs

Class TypeDefPatch

  • All Implemented Interfaces:
    Serializable
    public class TypeDefPatch
extends TypeDefElementHeader
    TypeDefPatch describes a change (patch) to a typeDef's properties, options, external standards mappings or list of valid instance statuses. A patch can be applied to an EntityDef, RelationshipDef or ClassificationDef. Changes to a TypeDef's category or superclasses requires a new type definition. In addition it is not possible to delete an attributeTypeDef through a patch.
    See Also:
    Serialized Form

    • Constructor Detail

      • TypeDefPatch

        public TypeDefPatch()
        Default constructor relies on the initialization of variables in their declaration.

      • TypeDefPatch

        public TypeDefPatch​(TypeDefPatch template)
        Copy/clone constructor
        Parameters:
        template - object to copy

    • Method Detail

      • getTypeDefGUID

        public String getTypeDefGUID()
        Return the unique identifier for the affected TypeDef.
        Returns:
        String guid

      • setTypeDefGUID

        public void setTypeDefGUID​(String typeDefGUID)
        Set up the unique identifier for the affected TypeDef.
        Parameters:
        typeDefGUID - String guid

      • getTypeDefName

        public String getTypeDefName()
        Return the unique name for the affected TypeDef.
        Returns:
        String name

      • setTypeDefName

        public void setTypeDefName​(String typeDefName)
        Set up the unique name for the affected TypeDef.
        Parameters:
        typeDefName - String name

      • getTypeDefStatus

        public TypeDefStatus getTypeDefStatus()
        Return any change in status for the TypeDef.
        Returns:
        TypeDefStatus enum

      • setTypeDefStatus

        public void setTypeDefStatus​(TypeDefStatus typeDefStatus)
        Set up a change in the status of the TypeDef
        Parameters:
        typeDefStatus - enum

      • getApplyToVersion

        public long getApplyToVersion()
        Return the version number of the TypeDef that this patch applies to.
        Returns:
        long version number

      • setApplyToVersion

        public void setApplyToVersion​(long applyToVersion)
        Set up the version number of the TypeDef that this patch applies to.
        Parameters:
        applyToVersion - long version number

      • getUpdateToVersion

        public long getUpdateToVersion()
        Return the new version number of the TypeDef.
        Returns:
        long version number

      • setUpdateToVersion

        public void setUpdateToVersion​(long updateToVersion)
        Set up the new version of the TypeDef.
        Parameters:
        updateToVersion - long version number

      • getNewVersionName

        public String getNewVersionName()
        Return the new version name ot use once the patch is applied.
        Returns:
        String version name

      • setNewVersionName

        public void setNewVersionName​(String newVersionName)
        Set up the new version name ot use once the patch is applied.
        Parameters:
        newVersionName - String version name

      • getUpdatedBy

        public String getUpdatedBy()
        Return the user name of the person that last updated the target TypeDef.
        Returns:
        String name

      • setUpdatedBy

        public void setUpdatedBy​(String updatedBy)
        Set up the user name of the person that last updated the target TypeDef.
        Parameters:
        updatedBy - String name

      • getUpdateTime

        public Date getUpdateTime()
        Return the date/time that the target TypeDef was last updated.
        Returns:
        Date

      • setUpdateTime

        public void setUpdateTime​(Date updateTime)
        Set up the date/time that the target TypeDef was last updated.
        Parameters:
        updateTime - Date

      • getDescription

        public String getDescription()
        Return the new description for the TypeDef.
        Returns:
        String description

      • setDescription

        public void setDescription​(String description)
        Set up the new description for the TypeDef
        Parameters:
        description - String description

      • getDescriptionGUID

        public String getDescriptionGUID()
        Return the unique identifier for the new glossary term that describes the TypeDef.
        Returns:
        String unique identifier

      • setDescriptionGUID

        public void setDescriptionGUID​(String descriptionGUID)
        Set up the unique identifier for the new glossary term that describes the TypeDef.
        Parameters:
        descriptionGUID - String unique identifier

      • getSuperType

        public TypeDefLink getSuperType()
        Return the new supertype.
        Returns:
        super type link

      • setSuperType

        public void setSuperType​(TypeDefLink superType)
        Set up the new super type.
        Parameters:
        superType - super type link

      • getPropertyDefinitions

        public List<TypeDefAttribute> getPropertyDefinitions()
        Return the list of typeDefAttributes that are either new or changing.
        Returns:
        list of TypeDefAttribute

      • setPropertyDefinitions

        public void setPropertyDefinitions​(List<TypeDefAttribute> propertyDefinitions)
        Set up the list of typeDefAttributes that are either new or changing.
        Parameters:
        propertyDefinitions - list of AttributeDefs

      • getTypeDefOptions

        public Map<String,​String> getTypeDefOptions()
        Return the TypeDef options for the patch.
        Returns:
        map of TypeDef Options that are new or changing.

      • setTypeDefOptions

        public void setTypeDefOptions​(Map<String,​String> typeDefOptions)
        Set up the TypeDef options for the patch.
        Parameters:
        typeDefOptions - map of TypeDef Options that are new or changing.

      • getExternalStandardMappings

        public List<ExternalStandardMapping> getExternalStandardMappings()
        Return the list of External Standards Mappings that are either new or changing.
        Returns:
        list of external standards mappings

      • setExternalStandardMappings

        public void setExternalStandardMappings​(List<ExternalStandardMapping> externalStandardMappings)
        Set up the list of External Standards Mappings that are either new or changing.
        Parameters:
        externalStandardMappings - list of external standards mappings

      • getValidInstanceStatusList

        public List<InstanceStatus> getValidInstanceStatusList()
        Return the list of valid statuses for an instance of this TypeDefPatch.
        Returns:
        list of valid statuses

      • setValidInstanceStatusList

        public void setValidInstanceStatusList​(List<InstanceStatus> validInstanceStatusList)
        Set up the new list of valid statuses for an instance of this TypeDef. This list must be more extensive that the existing list.
        Parameters:
        validInstanceStatusList - list of valid statuses

      • getInitialStatus

        public InstanceStatus getInitialStatus()
        Return the initial status setting for an instance of this type.
        Returns:
        InstanceStatus enum

      • setInitialStatus

        public void setInitialStatus​(InstanceStatus initialStatus)
        Set up the initial status setting for an instance of this type.
        Parameters:
        initialStatus - InstanceStatus enum

      • getValidEntityDefs

        public List<TypeDefLink> getValidEntityDefs()
        Return a list of EntityDef names this this ClassificationDef can be attached to.
        Returns:
        list of type def links

      • setValidEntityDefs

        public void setValidEntityDefs​(List<TypeDefLink> validEntityDefs)
        Set up a list of EntityDef names this this ClassificationDef can be attached to. This list must be the same or bigger than the previous version.
        Parameters:
        validEntityDefs - list of type def links

      • getEndDef1

        public RelationshipEndDef getEndDef1()
        Return the details associated with the first end of the relationship.
        Returns:
        endDef1 RelationshipEndDef

      • setEndDef1

        public void setEndDef1​(RelationshipEndDef endDef1)
        Set up the details associated with the first end of the relationship.
        Parameters:
        endDef1 - RelationshipEndDef

      • getEndDef2

        public RelationshipEndDef getEndDef2()
        Return the details associated with the second end of the relationship.
        Returns:
        endDef2 RelationshipEndDef

      • setEndDef2

        public void setEndDef2​(RelationshipEndDef endDef2)
        Set up the details associated with the second end of the relationship.
        Parameters:
        endDef2 - RelationshipEndDef

      • toString

        public String toString()
        Standard toString method.
        Overrides:
        toString in class Object
        Returns:
        JSON style description of variables.

      • equals

        public boolean equals​(Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class Object
        Parameters:
        objectToCompare - object
        Returns:
        boolean result

      • hashCode

        public int hashCode()
        Return a hash code based on the values of this object.
        Overrides:
        hashCode in class Object
        Returns:
        in hash code