Enum SortBy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SortBy>

    public enum SortBy
    extends java.lang.Enum<SortBy>
    Defines the options to sort digital assets and folders.

    The possible options to sort are:

    • Physical name.
    • Creation date.
    • Last updated date.
    • Digital asset's state
    • Digital asset's extension
    Since:
    1.6.0
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      com.orchestranetworks.schema.Path getSortPath()
      Deprecated. 
      com.orchestranetworks.schema.Path getSortPath​(DAMType damType)
      Get the sort path depending on DAM Type
      static SortBy parse​(java.lang.String sortType)
      Parses the SortBy.
      java.lang.String toString()  
      static SortBy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SortBy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • PHYSICAL_NAME

        public static final SortBy PHYSICAL_NAME
        The physical name.
      • CREATION_DATE

        public static final SortBy CREATION_DATE
        The creation date.
      • LAST_UPDATE_DATE

        public static final SortBy LAST_UPDATE_DATE
        The last update date.
      • DIGITAL_ASSET_TYPE

        public static final SortBy DIGITAL_ASSET_TYPE
        The digital asset type.
      • EXTENSION

        public static final SortBy EXTENSION
        The extension.
    • Method Detail

      • values

        public static SortBy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (SortBy c : SortBy.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SortBy valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • parse

        public static SortBy parse​(java.lang.String sortType)
        Parses the SortBy.
        Parameters:
        sortType - the sort type
        Returns:
        the sort by
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<SortBy>
      • getSortPath

        @Deprecated(since="6.1.1")
        public com.orchestranetworks.schema.Path getSortPath()
        Deprecated.
        Returns the sort path of the Digital asset.
        Since:
        6.1.1, replaced by getSortPath(DAMType)
      • getSortPath

        public com.orchestranetworks.schema.Path getSortPath​(DAMType damType)
        Get the sort path depending on DAM Type
        Parameters:
        damType - DAMType that can be used: DAMType.DIGITAL_ASSET and DAMType.FOLDER
        Returns:
        Path
        Since:
        6.1.1