|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<WsMemberFilter>
edu.internet2.middleware.grouper.ws.member.WsMemberFilter
public enum WsMemberFilter
member filter for retrieving members.
Enum Constant Summary | |
---|---|
All
retrieve all members (immediate, effective and composite) |
|
Composite
if this is a composite group, then return all the memberships that match the composite operator (union, intersection, complement). |
|
Effective
retrieve members which exist due a group as a member of another group (for composite groups, this will not return anything) |
|
Immediate
return only direct members of a group (for composite groups this will not return anything) |
|
NonImmediate
return only direct members of a group (for composite groups this will not return anything) |
Method Summary | |
---|---|
abstract java.util.Set<Group> |
getGroups(Member member,
Field field,
java.lang.String scope,
Stem stem,
Scope stemScope,
QueryOptions queryOptions,
java.lang.Boolean enabled)
get groups for subject based on field |
java.util.Set<Member> |
getMembers(Group group,
Field field,
java.util.Set<Source> sources)
get the members from the group based on type of filter |
java.util.Set<Membership> |
getMemberships(Group group,
Field field)
get the memberships from the group based on type of filter |
abstract MembershipType |
getMembershipType()
get the membership type for this member filter |
boolean |
hasMember(Group group,
Subject subject,
Field field)
see if a subject is in a group |
static WsMemberFilter |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static WsMemberFilter |
valueOfIgnoreCase(java.lang.String string)
do a case-insensitive matching |
static WsMemberFilter[] |
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 |
---|
public static final WsMemberFilter All
public static final WsMemberFilter Effective
public static final WsMemberFilter Immediate
public static final WsMemberFilter Composite
public static final WsMemberFilter NonImmediate
Method Detail |
---|
public static WsMemberFilter[] values()
for (WsMemberFilter c : WsMemberFilter.values()) System.out.println(c);
public static WsMemberFilter valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic final java.util.Set<Member> getMembers(Group group, Field field, java.util.Set<Source> sources)
group
- field
- for membership or null to not check fieldsources
- are the sources to filter the members
public abstract MembershipType getMembershipType()
public final java.util.Set<Membership> getMemberships(Group group, Field field)
group
- field
- for membership or null to not check field
SchemaException
- is there is a problem with fieldpublic final boolean hasMember(Group group, Subject subject, Field field)
group
- subject
- field
-
SchemaException
public abstract java.util.Set<Group> getGroups(Member member, Field field, java.lang.String scope, Stem stem, Scope stemScope, QueryOptions queryOptions, java.lang.Boolean enabled)
member
- field
- field
- to check with membershipscope
- stem
- stemScope
- enabled
- queryOptions
-
public static WsMemberFilter valueOfIgnoreCase(java.lang.String string)
string
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |