edu.internet2.middleware.grouper.group
Enum TypeOfGroup

java.lang.Object
  extended by java.lang.Enum<TypeOfGroup>
      extended by edu.internet2.middleware.grouper.group.TypeOfGroup
All Implemented Interfaces:
Serializable, Comparable<TypeOfGroup>

public enum TypeOfGroup
extends Enum<TypeOfGroup>

Author:
mchyzer

Enum Constant Summary
entity
          can be used as a subject which is not in a subject source, e.g.
group
          group (normal group of subjects)
role
          can be assigned groups or other subjects, and also privileges
 
Field Summary
static Set<TypeOfGroup> ENTITY_SET
          set with entity
static Set<TypeOfGroup> GROUP_OR_ROLE_SET
          set with group or role
 
Method Summary
static void appendHqlQuery(String groupAlias, Set<TypeOfGroup> typeOfGroups, StringBuilder hql, HqlQuery hqlQuery)
          append the typeOfGroup part into an hql group query
 String getName()
          name for javabeans
abstract  boolean supportsField(Field field)
          if this type of group supports this field (i.e.
static TypeOfGroup valueOf(String name)
          Returns the enum constant of this type with the specified name.
static TypeOfGroup valueOfIgnoreCase(String string, boolean exceptionOnNull)
          do a case-insensitive matching
static TypeOfGroup[] 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

group

public static final TypeOfGroup group
group (normal group of subjects)


role

public static final TypeOfGroup role
can be assigned groups or other subjects, and also privileges


entity

public static final TypeOfGroup entity
can be used as a subject which is not in a subject source, e.g. a service principal, schema, server, etc

Field Detail

GROUP_OR_ROLE_SET

public static final Set<TypeOfGroup> GROUP_OR_ROLE_SET
set with group or role


ENTITY_SET

public static final Set<TypeOfGroup> ENTITY_SET
set with entity

Method Detail

values

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

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

valueOf

public static TypeOfGroup valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getName

public String getName()
name for javabeans

Returns:
the name

appendHqlQuery

public static void appendHqlQuery(String groupAlias,
                                  Set<TypeOfGroup> typeOfGroups,
                                  StringBuilder hql,
                                  HqlQuery hqlQuery)
append the typeOfGroup part into an hql group query

Parameters:
groupAlias - is the alias in the group hql query e.g. theGroup
typeOfGroups - the set of TypeOfGroup or null for all
hql - query so far
hqlQuery - object to append the stored params to

supportsField

public abstract boolean supportsField(Field field)
if this type of group supports this field (i.e. entities dont have READ privilege or members list)

Parameters:
field -
Returns:
true if supports

valueOfIgnoreCase

public static TypeOfGroup valueOfIgnoreCase(String string,
                                            boolean exceptionOnNull)
do a case-insensitive matching

Parameters:
string -
exceptionOnNull - will not allow null or blank entries
Returns:
the enum or null or exception if not found