Enum MediaItemVersion.SearchEngineInclude

  • All Implemented Interfaces:
    Serializable, Comparable<MediaItemVersion.SearchEngineInclude>
    Enclosing interface:
    MediaItemVersion

    public static enum MediaItemVersion.SearchEngineInclude
    extends Enum<MediaItemVersion.SearchEngineInclude>
    Enumeration that contains the possible options for the mediaitem searchengine include options. There are 3 options: 'yes' (1) when the mediaitem should always be included in the searchengine 'no' (0) when the mediaitem should never be included in the searchengine 'inherit' (-1) when the display-on page should define whether the mediaitem should be included in the searchengine
    Since:
    10.31.0
    • Method Detail

      • values

        public static MediaItemVersion.SearchEngineInclude[] 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 (MediaItemVersion.SearchEngineInclude c : MediaItemVersion.SearchEngineInclude.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static MediaItemVersion.SearchEngineInclude valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getValue

        public int getValue()
        Returns the internal value of the enumeration.
        Returns:
        the internal value of the enumeration: 1 for index, 0 for no index or -1 to inherit from display-on page
      • getText

        public String getText()
        Returns the textual representation of the enumeration value.
        Returns:
        the textual representation of the enumeration value: 'yes', 'no' or 'inherit' (from display-on page)
      • fromString

        public static MediaItemVersion.SearchEngineInclude fromString​(String text)
        Retrieve the enumeration object based on the string representation.
        Parameters:
        text - the string representation to use
        Returns:
        the enumeration object based on the string representation
      • fromValue

        public static MediaItemVersion.SearchEngineInclude fromValue​(int value)
        Retrieve the enumeration object based on the integer representation.
        Parameters:
        value - the integer representation to use
        Returns:
        the enumeration object based on the integer representation