Class CollectionProperties

  • All Implemented Interfaces:
    java.io.Serializable

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

      • CollectionProperties

        public CollectionProperties()
        Default constructor
      • CollectionProperties

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

      • getName

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

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

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

        public void setDescription​(java.lang.String description)
        Set up the description of the collection.
        Parameters:
        description - text
      • 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 java.lang.String getOrderPropertyName()
        Return the property name for CollectionOrder.OTHER.
        Returns:
        string property name
      • setOrderPropertyName

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

        public java.lang.String toString()
        JSON-style toString
        Overrides:
        toString in class ReferenceableProperties
        Returns:
        return string containing the property names and values
      • equals

        public boolean equals​(java.lang.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