Package edu.internet2.middleware.grouper.ws.query

Enum Class WsQueryFilterType

java.lang.Object

java.lang.Enum<WsQueryFilterType>

edu.internet2.middleware.grouper.ws.query.WsQueryFilterType

All Implemented Interfaces:

Serializable, Comparable<WsQueryFilterType>, Constable

public enum WsQueryFilterType
extends Enum<WsQueryFilterType>

type of find group queries

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AND	and two queries together
FIND_BY_APPROXIMATE_ATTRIBUTE	find by query, configure all the query params
FIND_BY_EXACT_ATTRIBUTE	find by exact attribute, configure all the query params
FIND_BY_GROUP_NAME_APPROXIMATE	find by approx name, pass the name in, and optionally a stem name
FIND_BY_GROUP_NAME_EXACT	find by exact name, pass the name in
FIND_BY_GROUP_UUID	find by uuid.
FIND_BY_STEM_NAME	find by children of stem.
FIND_BY_TYPE	find by group type
MINUS	complement one query, set A minus set B
OR	or two queries together

Method Summary

Modifier and Type	Method	Description
abstract QueryFilter	retrieveQueryFilter(WsQueryFilter wsQueryFilter)	return the query filter
abstract void	validate(WsQueryFilter wsGroupQuery)	make sure that based on the inputs, that this is a valid query
static WsQueryFilterType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WsQueryFilterType	valueOfIgnoreCase(String string)	do a case-insensitive matching
static WsQueryFilterType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FIND_BY_GROUP_UUID

public static final WsQueryFilterType FIND_BY_GROUP_UUID

find by uuid. pass the uuid in.

FIND_BY_GROUP_NAME_EXACT

public static final WsQueryFilterType FIND_BY_GROUP_NAME_EXACT

find by exact name, pass the name in

FIND_BY_GROUP_NAME_APPROXIMATE

public static final WsQueryFilterType FIND_BY_GROUP_NAME_APPROXIMATE

find by approx name, pass the name in, and optionally a stem name

FIND_BY_STEM_NAME

public static final WsQueryFilterType FIND_BY_STEM_NAME

find by children of stem. pass the stem in

FIND_BY_APPROXIMATE_ATTRIBUTE

public static final WsQueryFilterType FIND_BY_APPROXIMATE_ATTRIBUTE

find by query, configure all the query params

FIND_BY_EXACT_ATTRIBUTE

public static final WsQueryFilterType FIND_BY_EXACT_ATTRIBUTE

find by exact attribute, configure all the query params

FIND_BY_TYPE

public static final WsQueryFilterType FIND_BY_TYPE

find by group type

AND

public static final WsQueryFilterType AND

and two queries together

OR

public static final WsQueryFilterType OR

or two queries together

MINUS

public static final WsQueryFilterType MINUS

complement one query, set A minus set B

Method Details

values

public static WsQueryFilterType[] 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 WsQueryFilterType 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

validate

public abstract void validate(WsQueryFilter wsGroupQuery)
                       throws WsInvalidQueryException

make sure that based on the inputs, that this is a valid query

Parameters:

wsGroupQuery - is the query params to validate based on type

Throws:

WsInvalidQueryException - if invalid

valueOfIgnoreCase

public static WsQueryFilterType valueOfIgnoreCase(String string)

do a case-insensitive matching

Parameters:

string -

Returns:

the enum or null or exception if not found

retrieveQueryFilter

public abstract QueryFilter retrieveQueryFilter(WsQueryFilter wsQueryFilter)

return the query filter

Parameters:

wsQueryFilter -

Returns:

the query filter