Package org.odpi.openmetadata.accessservices.assetowner.properties

Class AssetProperties

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    DataStoreProperties
    public class AssetProperties
extends ReferenceableProperties
    AssetProperties holds asset properties that are used for displaying details of an asset in summary lists or hover text. It includes the following properties:
    • type - metadata type information for the asset
    • guid - globally unique identifier for the asset
    • url - external link for the asset
    • qualifiedName - The official (unique) name for the asset. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages. (qualifiedName from Referenceable - model 0010)
    • displayName - A consumable name for the asset. Often a shortened form of the assetQualifiedName for use on user interfaces and messages. The assetDisplayName should only be used for audit logs and error messages if the assetQualifiedName is not set. (Sourced from attribute name within Asset - model 0010)
    • shortDescription - short description about the asset. (Sourced from assetSummary within ConnectionsToAsset - model 0205)
    • description - full description of the asset. (Sourced from attribute description within Asset - model 0010)
    • owner - name of the person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
    • ownerTypeName - name of the element type identifying the person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
    • ownerPropertyName - name of the property identifying person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
    • ownerType - type of the the person or organization that owns the asset. (Sourced from classification AssetOwnership attached to Asset - model 0445)
    • zoneMembership - name of the person or organization that owns the asset. (Sourced from classification AssetZoneMemberShip attached to Asset - model 0424)
    • origin - origin identifiers describing the source of the asset. (Sourced from classification AssetOrigin attached to Asset - model 0440)
    • classifications - list of all classifications assigned to the asset
    • extendedProperties - list of properties assigned to the asset from the Asset subclasses
    • additionalProperties - list of properties assigned to the asset as additional properties
    See Also:
    Serialized Form

    • Constructor Detail

      • AssetProperties

        public AssetProperties()
        Default constructor

      • AssetProperties

        public AssetProperties​(AssetProperties template)
        Copy/clone constructor. Note, this is a deep copy
        Parameters:
        template - object to copy

    • Method Detail

      • 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

      • getOwnerTypeName

        public String getOwnerTypeName()
        Returns the name of the type used to identify of the owner for this asset.
        Returns:
        owner String

      • setOwnerTypeName

        public void setOwnerTypeName​(String ownerTypeName)
        Set up the name of the type used to identify the owner for this asset.
        Parameters:
        ownerTypeName - String name

      • getOwnerPropertyName

        public String getOwnerPropertyName()
        Returns the property name used to identify the owner for this asset.
        Returns:
        owner String

      • setOwnerPropertyName

        public void setOwnerPropertyName​(String ownerPropertyName)
        Set up the property name used to identify the owner for this asset.
        Parameters:
        ownerPropertyName - String name

      • getOwnerType

        @Deprecated
public OwnerType getOwnerType()
        Deprecated.
        Return the type of owner stored in the owner property.
        Returns:
        OwnerType enum

      • setOwnerType

        @Deprecated
public void setOwnerType​(OwnerType ownerType)
        Deprecated.
        Set up the owner type for this asset.
        Parameters:
        ownerType - OwnerType enum

      • getZoneMembership

        public List<String> getZoneMembership()
        Return the names of the zones that this asset 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 asset is a member of.
        Parameters:
        zoneMembership - list of zone names

      • getOriginOrganizationGUID

        public String getOriginOrganizationGUID()
        Return the unique identifier for the organization that originated this asset.
        Returns:
        string guid

      • setOriginOrganizationGUID

        public void setOriginOrganizationGUID​(String originOrganizationGUID)
        Set up the unique identifier for the organization that originated this asset.
        Parameters:
        originOrganizationGUID - string guid

      • getOriginBusinessCapabilityGUID

        public String getOriginBusinessCapabilityGUID()
        Return the unique identifier of the business capability that originated this asset.
        Returns:
        string guid

      • setOriginBusinessCapabilityGUID

        public void setOriginBusinessCapabilityGUID​(String originBusinessCapabilityGUID)
        Set up the unique identifier of the business capability that originated this asset.
        Parameters:
        originBusinessCapabilityGUID - string guid

      • getOtherOriginValues

        public Map<String,​String> getOtherOriginValues()
        Return the properties that characterize where this asset 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 asset is from.
        Parameters:
        otherOriginValues - map of name value pairs, all strings

      • equals

        public boolean equals​(Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class ReferenceableProperties
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison