Package org.odpi.openmetadata.frameworks.openmetadata.properties.collections

Class CollectionMembershipProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionMembershipProperties
public class CollectionMembershipProperties extends RelationshipProperties
CollectionMember describes a member of a collection.

  • Constructor Details

    • CollectionMembershipProperties

      public CollectionMembershipProperties()
      Default constructor

    • CollectionMembershipProperties

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

  • Method Details

    • getMembershipRationale

      public String getMembershipRationale()
      Return the rationale or role of the asset in this collection.
      Returns:
      text

    • setMembershipRationale

      public void setMembershipRationale(String membershipRationale)
      Set up the rationale or role of the asset in this collection.
      Parameters:
      membershipRationale - text

    • getCreatedBy

      public String getCreatedBy()
      Return the identifier of the person/process that created this membership. The userId of the creator is automatically captured. This field can be used to add additional information about the creator. For example, this could be the identifier of a process instance that created the membership relationship.
      Returns:
      string

    • setCreatedBy

      public void setCreatedBy(String createdBy)
      Set up the identifier of the person/process that created this membership. The userId of the creator is automatically captured. This field can be used to add additional information about the creator. For example, this could be the identifier of a process instance that created the membership relationship.
      Parameters:
      createdBy - string

    • getExpression

      public String getExpression()
      Return the expression used to determine the membership. This is used by automated processes that are determining membership through one or more matching algorithms. This string helps the steward understand the type of match made.
      Returns:
      string

    • setExpression

      public void setExpression(String expression)
      Set up the expression used to determine the membership. This is used by automated processes that are determining membership through one or more matching algorithms. This string helps the steward understand the type of match made.
      Parameters:
      expression - string

    • getConfidence

      public int getConfidence()
      Return the confidence level (0-100) that the matching is correct.
      Returns:
      int

    • setConfidence

      public void setConfidence(int confidence)
      Set up the confidence level (0-100) that the matching is correct.
      Parameters:
      confidence - int

    • getStatus

      public CollectionMemberStatus getStatus()
      Return the status of the membership in the collection.
      Returns:
      enum

    • setStatus

      public void setStatus(CollectionMemberStatus status)
      Set up the status of the membership in the collection.
      Parameters:
      status - enum

    • getUserDefinedStatus

      public String getUserDefinedStatus()
      Return the status of the membership in the collection. This status is controlled by the local deployment.
      Returns:
      string

    • setUserDefinedStatus

      public void setUserDefinedStatus(String userDefinedStatus)
      Set up the status of the membership in the collection. This status is controlled by the local deployment.
      Parameters:
      userDefinedStatus - string

    • getSource

      public String getSource()
      Return the source of information that determined the membership.
      Returns:
      string

    • setSource

      public void setSource(String source)
      Set up the source of information that determined the membership.
      Parameters:
      source - string

    • getSteward

      public String getSteward()
      Returns the id of the steward responsible for the mapping.
      Returns:
      String id

    • setSteward

      public void setSteward(String steward)
      Set up the id of the steward responsible for the mapping.
      Parameters:
      steward - String id

    • getStewardTypeName

      public String getStewardTypeName()
      Return the type of element that describes the steward.
      Returns:
      type name

    • setStewardTypeName

      public void setStewardTypeName(String stewardTypeName)
      Set up the type of element that describes the steward.
      Parameters:
      stewardTypeName - type name

    • getStewardPropertyName

      public String getStewardPropertyName()
      Return the name of the property that holds the steward's identifier.
      Returns:
      property name

    • setStewardPropertyName

      public void setStewardPropertyName(String stewardPropertyName)
      Set up the name of the property that holds the steward's identifier.
      Parameters:
      stewardPropertyName - property name

    • getNotes

      public String getNotes()
      Return the additional values associated with the symbolic name.
      Returns:
      string text

    • setNotes

      public void setNotes(String notes)
      Set up the additional values associated with the symbolic name.
      Parameters:
      notes - string text

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class RelationshipProperties
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class RelationshipProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class RelationshipProperties
      Returns:
      int hash code