Package com.peterphi.std.guice.restclient.jaxb.webquery

Enum Class WQUriControlField

java.lang.Object
java.lang.Enum<WQUriControlField>
com.peterphi.std.guice.restclient.jaxb.webquery.WQUriControlField
All Implemented Interfaces:
Serializable, Comparable<WQUriControlField>, Constable
public enum WQUriControlField extends Enum<WQUriControlField>
Special WebQuery fields and their wire representation in the Query String API

  • Enum Constant Details

    • OFFSET

      public static final WQUriControlField OFFSET
      Set the index of the first result to return for this query

    • LIMIT

      public static final WQUriControlField LIMIT
      Set to the maximum results to return for this query; a special limit of -1 (see WebQuery.LIMIT_RETURN_ZERO) requests no row data (useful when just wanting a count of resultset size.

    • ORDER

      public static final WQUriControlField ORDER

    • COMPUTE_SIZE

      public static final WQUriControlField COMPUTE_SIZE
      Set to true to request the resultset size be computed

    • LOG_SQL

      public static final WQUriControlField LOG_SQL
      Set to true to request that the SQL prepared statements as a result of this query be recorded as part of the resultset

    • LOG_PERFORMANCE

      public static final WQUriControlField LOG_PERFORMANCE
      Set to true to request performance metrics be reported for this query

    • CLASS

      public static final WQUriControlField CLASS
      Set to some class to specify the subclass to return (for entities with type hierarchies)

    • EXPAND

      public static final WQUriControlField EXPAND
      Set to some comma-separated list of relationships to expand. This is handled after the query completes and the results are being serialised

    • FETCH

      public static final WQUriControlField FETCH
      Set to entity (the default) or id to fetch back the entity or just the entity primary key. This is handled after the query completes and the results are being serialised

    • DBFETCH

      public static final WQUriControlField DBFETCH
      Controls which relationships are eagerly fetched during the database query. N.B. the more relationships that are eagerly fetched the larger the db result set and therefore the slower the query will perform - strike a balance and take account of the value of expand

    • NAME

      public static final WQUriControlField NAME
      An optional name for the query, to allow server-side optimisation/hinting

    • TEXT_QUERY

      public static final WQUriControlField TEXT_QUERY

  • Method Details

    • values

      public static WQUriControlField[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static WQUriControlField valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Return the name of this field when used in maps
      Returns:

    • getByName

      public static WQUriControlField getByName(String fieldName)

    • getAllNames

      public static List<String> getAllNames()
      Return all the permitted names
      Returns: