GrouperSetEnum

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

edu.internet2.middleware.grouper.grouperSet
Enum GrouperSetEnum

java.lang.Object
  java.lang.Enum<GrouperSetEnum>
      edu.internet2.middleware.grouper.grouperSet.GrouperSetEnum

All Implemented Interfaces:: Serializable, Comparable<GrouperSetEnum>

public enum GrouperSetEnum
extends Enum<GrouperSetEnum>
extends Enum<GrouperSetEnum>

Enum Constant Summary
`ATTRIBUTE_ASSIGN_ACTION_SET` attribute assign action set grouper set
`ATTRIBUTE_SET` attribute set grouper set
`ROLE_SET` role set grouper set

Method Summary
`boolean`	`addToGrouperSet(GrouperSetElement containerSetElement, GrouperSetElement newElement, String uuid)`
`abstract GrouperSet`	`findById(String id, boolean exceptionIfNull)` find by id if has id
`abstract Set<? extends GrouperSet>`	`findByIfHasElementId(String idIf)` find set of sets which have an if as a certain value
`abstract Set<? extends GrouperSet>`	`findByIfThenHasElementId(String idForThens, String idForIfs)` find canidates to delete by if and then
`abstract GrouperSet`	`findByIfThenImmediate(String idIf, String idThen, boolean exceptionIfNotFound)` find an element by if then immediate (or null
`abstract Set<? extends GrouperSet>`	`findByThenHasElementId(String idThen)` find set of sets which have a then as a certain value
`abstract GrouperSet`	`newInstance(String ifHasId, String thenHasId, int depth, String uuid)` new instance of the grouper set object
`boolean`	`removeFromGrouperSet(GrouperSetElement setToRemoveFrom, GrouperSetElement elementToRemove)`
`static GrouperSetEnum`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GrouperSetEnum[]`	`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

ATTRIBUTE_SET

public static final GrouperSetEnum ATTRIBUTE_SET

attribute set grouper set

ROLE_SET

public static final GrouperSetEnum ROLE_SET

role set grouper set

ATTRIBUTE_ASSIGN_ACTION_SET

public static final GrouperSetEnum ATTRIBUTE_ASSIGN_ACTION_SET

attribute assign action set grouper set

Method Detail

values

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

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

valueOf

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

findByIfThenImmediate

public abstract GrouperSet findByIfThenImmediate(String idIf,
                                                 String idThen,
                                                 boolean exceptionIfNotFound)

find an element by if then immediate (or null

Parameters:: idIf -; idThen -; exceptionIfNotFound - true if exception if not found
Returns:: the element if found

findByThenHasElementId

public abstract Set<? extends GrouperSet> findByThenHasElementId(String idThen)

find set of sets which have a then as a certain value

Parameters:: idThen -
Returns:: the set

findByIfHasElementId

public abstract Set<? extends GrouperSet> findByIfHasElementId(String idIf)

find set of sets which have an if as a certain value

Parameters:: idIf -
Returns:: the set

findById

public abstract GrouperSet findById(String id,
                                    boolean exceptionIfNull)

find by id if has id

Parameters:: id -; exceptionIfNull -
Returns:: the grouper set

newInstance

public abstract GrouperSet newInstance(String ifHasId,
                                       String thenHasId,
                                       int depth,
                                       String uuid)

new instance of the grouper set object

Parameters:: ifHasId -; thenHasId -; depth -; uuid - is uuid or null if generate one
Returns:: the grouper set

findByIfThenHasElementId

public abstract Set<? extends GrouperSet> findByIfThenHasElementId(String idForThens,
                                                                   String idForIfs)

find canidates to delete by if and then

Parameters:: idForThens -; idForIfs -
Returns:: the canidate set to delete

addToGrouperSet

public boolean addToGrouperSet(GrouperSetElement containerSetElement,
                               GrouperSetElement newElement,
                               String uuid)

Parameters:: containerSetElement -; newElement -; uuid - is the uuid or null to generate
Returns:: true if added, false if already there

removeFromGrouperSet

public boolean removeFromGrouperSet(GrouperSetElement setToRemoveFrom,
                                    GrouperSetElement elementToRemove)

Parameters:: setToRemoveFrom -; elementToRemove -
Returns:: true if removed, false if already removed