Package edu.internet2.middleware.grouper.ws.member

Enum Class WsMemberFilter

java.lang.Object
java.lang.Enum<WsMemberFilter>
edu.internet2.middleware.grouper.ws.member.WsMemberFilter
All Implemented Interfaces:
Serializable, Comparable<WsMemberFilter>, Constable
public enum WsMemberFilter extends Enum<WsMemberFilter>
member filter for retrieving members.

  • Enum Constant Details

    • All

      public static final WsMemberFilter All
      retrieve all members (immediate, effective and composite)

    • Effective

      public static final WsMemberFilter Effective
      retrieve members which exist due a group as a member of another group (for composite groups, this will not return anything)

    • Immediate

      public static final WsMemberFilter Immediate
      return only direct members of a group (for composite groups this will not return anything)

    • Composite

      public static final WsMemberFilter Composite
      if this is a composite group, then return all the memberships that match the composite operator (union, intersection, complement). This will be the same as All for composite groups.

    • NonImmediate

      public static final WsMemberFilter NonImmediate
      return only direct members of a group (for composite groups this will not return anything)

  • Method Details

    • values

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

    • getMembers

      public final Set<Member> getMembers(Group group, Field field, Set<Source> sources, QueryOptions queryOptions)
      get the members from the group based on type of filter
      Parameters:
      group -
      field - for membership or null to not check field
      sources - are the sources to filter the members
      queryOptions -
      Returns:
      the set of members (non null)

    • getMembershipType

      public abstract MembershipType getMembershipType()
      get the membership type for this member filter
      Returns:
      the membership type

    • getMembersHelper

      protected abstract Set<Member> getMembersHelper(Group group, Field field, Set<Source> sources, QueryOptions queryOptions) throws SchemaException
      get the members from the group based on type of filter
      Parameters:
      group -
      field - for membership or null to not check field
      sources -
      queryOptions -
      Returns:
      the set of members (non null)
      Throws:
      SchemaException - if problem with field

    • getMembershipsHelper

      protected abstract Set<Membership> getMembershipsHelper(Group group, Field field) throws SchemaException
      get the memberships from the group based on type of filter
      Parameters:
      group -
      field - for membership or null to not check field
      Returns:
      the set of members (non null)
      Throws:
      SchemaException - is there is a problem with field

    • getMemberships

      public final Set<Membership> getMemberships(Group group, Field field)
      get the memberships from the group based on type of filter
      Parameters:
      group -
      field - for membership or null to not check field
      Returns:
      the set of members (non null)
      Throws:
      SchemaException - is there is a problem with field

    • hasMemberHelper

      protected abstract boolean hasMemberHelper(Group group, Subject subject, Field field) throws SchemaException
      see if a subject is in a group
      Parameters:
      group -
      subject -
      field -
      Returns:
      the set of members (non null)
      Throws:
      SchemaException

    • hasMember

      public final boolean hasMember(Group group, Subject subject, Field field)
      see if a subject is in a group
      Parameters:
      group -
      subject -
      field -
      Returns:
      the set of members (non null)
      Throws:
      SchemaException

    • getGroups

      public abstract Set<Group> getGroups(Member member, Field field, String scope, Stem stem, Stem.Scope stemScope, QueryOptions queryOptions, Boolean enabled)
      get groups for subject based on field
      Parameters:
      member -
      field -
      field - to check with membership
      scope -
      stem -
      stemScope -
      enabled -
      queryOptions -
      Returns:
      the set of members (non null)

    • valueOfIgnoreCase

      public static WsMemberFilter valueOfIgnoreCase(String string)
      do a case-insensitive matching
      Parameters:
      string -
      Returns:
      the enum or null or exception if not found