com.peterphi.std.guice.restclient.jaxb.webquery.WQUriControlField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stdlib-guice-common Show documentation

stdlib guice common

There is a newer version: 10.1.5

package com.peterphi.std.guice.restclient.jaxb.webquery;

/**
 * Special WebQuery fields and their wire representation in the Query String API
 */
public enum WQUriControlField
{
	/**
	 * Set the index of the first result to return for this query
	 */
	OFFSET("_offset"),
	/**
	 * Set to the maximum results to return for this query
	 */
	LIMIT("_limit"),
	ORDER("_order"),
	/**
	 * Set to true to request the resultset size be computed
	 */
	COMPUTE_SIZE("_compute_size"),
	/**
	 * Set to some class to specify the subclass to return (for entities with type hierarchies)
	 */
	CLASS("_class"),

	/**
	 * Set to some comma-separated list of relationships to expand. This is handled after the query completes and the results are
	 * being serialised
	 */
	EXPAND("_expand"),
	/**
	 * 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
	 */
	FETCH("_fetch");

	private final String name;


	WQUriControlField(final String name)
	{
		this.name = name;
	}


	/**
	 * Return the name of this field when used in maps
	 *
	 * @return
	 */
	public String getName()
	{
		return name;
	}


	public static WQUriControlField getByName(final String fieldName)
	{
		for (WQUriControlField field : values())
		{
			if (field.name.equals(fieldName))
				return field;
		}

		throw new IllegalArgumentException("No core WebQueryField with name: " + fieldName);
	}
}