edu.internet2.middleware.grouper.ws.query

Enum WsStemQueryFilterType

java.lang.Object

java.lang.Enum<WsStemQueryFilterType>

edu.internet2.middleware.grouper.ws.query.WsStemQueryFilterType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WsStemQueryFilterType>

public enum WsStemQueryFilterType
extends java.lang.Enum<WsStemQueryFilterType>

type of find group queries

Enum Constant Summary

Enum Constants

Enum Constant and Description
AND and two queries together
FIND_BY_APPROXIMATE_ATTRIBUTE find by query, configure all the query params.
FIND_BY_PARENT_STEM_NAME find by children of stem.
FIND_BY_STEM_NAME find by exact name, pass the name in.
FIND_BY_STEM_NAME_APPROXIMATE find by approx name, pass the name in.
FIND_BY_STEM_UUID find by uuid.
MINUS complement one query, set A minus set B
OR or two queries together

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIND_BY_STEM_UUID

public static final WsStemQueryFilterType FIND_BY_STEM_UUID

find by uuid. pass the uuid in. uuid is requried, all other params are forbidden

FIND_BY_STEM_NAME

public static final WsStemQueryFilterType FIND_BY_STEM_NAME

find by exact name, pass the name in. stem name is required, all others forbidden

FIND_BY_STEM_NAME_APPROXIMATE

public static final WsStemQueryFilterType FIND_BY_STEM_NAME_APPROXIMATE

find by approx name, pass the name in. stem name is required, optionally pass in parentStem name

FIND_BY_PARENT_STEM_NAME

public static final WsStemQueryFilterType FIND_BY_PARENT_STEM_NAME

find by children of stem. parentStemName is required, parentStemNameScope is optional. all others forbidden.

FIND_BY_APPROXIMATE_ATTRIBUTE

public static final WsStemQueryFilterType FIND_BY_APPROXIMATE_ATTRIBUTE

find by query, configure all the query params. attribute value is required, parentStemName is optional, attributeName is optional (defaults to all)

AND

public static final WsStemQueryFilterType AND

and two queries together

OR

public static final WsStemQueryFilterType OR

or two queries together

MINUS

public static final WsStemQueryFilterType MINUS

complement one query, set A minus set B

Method Detail

values

public static WsStemQueryFilterType[] 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 (WsStemQueryFilterType c : WsStemQueryFilterType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WsStemQueryFilterType 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

validate

public abstract void validate(WsStemQueryFilter wsStemQuery)
                       throws WsInvalidQueryException

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

Parameters:

wsStemQuery - is the query params to validate based on type

Throws:

WsInvalidQueryException - if invalid

valueOfIgnoreCase

public static WsStemQueryFilterType valueOfIgnoreCase(java.lang.String string)

do a case-insensitive matching

Parameters:

string -

Returns:

the enum or null or exception if not found

retrieveQueryFilter

public abstract QueryFilter retrieveQueryFilter(WsStemQueryFilter wsStemQueryFilter)

return the query filter

Parameters:

wsStemQueryFilter -

Returns:

the query filter