Package com.saperion.rs.federatedsearch

Enum FederatedSearch.ConfigParameter

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ARCHIVE
      The name of the DDC archive to be used by this federated search feed.
      DESCRIPTION
      The description of the federated search feed.
      DESCRIPTION_FIELD
      The DDC field to be used as the result's description.
      GLOBAL_QUERY
      The global query of the federated search feed.
      GLOBAL_QUERY_FIELD
      The global query field of the federated search feed.
      NAME
      The name of the federated search feed.
      PUBLISHED_FIELD
      The DDC field to be used as the result's published date.
      QUERY_SIZE
      The size of query results of the federated search feed.
      QUERY_STRATEGY
      The query strategy to build HQL queries from the users query.
      SPECIAL_QUERY
      The special query of the federated search feed.
      TAGS_FIELD
      The DDC field to be used as the result's tags.
      TITLE_FIELD
      The DDC field to be used as the result's title.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FederatedSearch.ConfigParameter valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FederatedSearch.ConfigParameter[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

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

      • valueOf

        public static FederatedSearch.ConfigParameter 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