java.lang.Object
org.odpi.openmetadata.accessservices.digitalarchitecture.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.digitalarchitecture.properties.CollectionProperties
All Implemented Interfaces:
Serializable

public class CollectionProperties extends ReferenceableProperties
CollectionProperties describes the core properties of a collection.
See Also:
  • Constructor Details

    • CollectionProperties

      public CollectionProperties()
      Default constructor
    • CollectionProperties

      public CollectionProperties(CollectionProperties template)
      Copy/clone constructor
      Parameters:
      template - object to copy
  • Method Details

    • getName

      public String getName()
      Return the name of the collection.
      Returns:
      string name
    • setName

      public void setName(String name)
      Set up the name of the collection.
      Parameters:
      name - string name
    • getDescription

      public String getDescription()
      Return the description of the collection.
      Returns:
      text
    • setDescription

      public void setDescription(String description)
      Set up the description of the collection.
      Parameters:
      description - text
    • getCollectionType

      public String getCollectionType()
      Return a descriptive name for the collection's type.
      Returns:
      string name
    • setCollectionType

      public void setCollectionType(String collectionType)
      Set up a descriptive name for the collection's type.
      Parameters:
      collectionType - string name
    • getCollectionOrdering

      public CollectionOrder getCollectionOrdering()
      Return the property to use to determine the order that assets are returned.
      Returns:
      CollectionOrder enum
    • setCollectionOrdering

      public void setCollectionOrdering(CollectionOrder collectionOrdering)
      Set up the property to use to determine the order that assets are returned.
      Parameters:
      collectionOrdering - CollectionOrder enum
    • getOrderPropertyName

      public String getOrderPropertyName()
      Return the property name for CollectionOrder.OTHER.
      Returns:
      string property name
    • setOrderPropertyName

      public void setOrderPropertyName(String orderPropertyName)
      Set up the property name for CollectionOrder.OTHER.
      Parameters:
      orderPropertyName - string property name
    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class ReferenceableProperties
      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 ReferenceableProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison
    • hashCode

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