Class ContextMembershipQuery

  • All Implemented Interfaces:
    java.io.Serializable

    public class ContextMembershipQuery
    extends MembershipQuery
    This class represents criteria to use to query membership information.
    Since:
    2.3
    See Also:
    Serialized Form
    • Field Detail

      • LEVEL

        public static final Column LEVEL
        The column that represents the number of levels in which the member is nested as with groups of groups.
      • LINEAGE

        public static final Column LINEAGE
        The column that represents the lineage of the location in which the member originated.
      • GROUP_CONTEXT

        public static final Column GROUP_CONTEXT
        The column that represents the context path in which the group member is defined. This column is blank for users.
      • PARENT_GROUP

        public static final Column PARENT_GROUP
        The column that represents the name of the parent group, if it exists.
      • PARENT_GROUP_CONTEXT

        public static final Column PARENT_GROUP_CONTEXT
        The column that represents the context path of the parent group, if it exists.
      • ALL

        public static final java.util.List<Column> ALL
        The value that represents all columns in ContextMembershipQuery.
    • Constructor Detail

      • ContextMembershipQuery

        public ContextMembershipQuery​(java.lang.String contextPath)
        The constructor with all of the required fields.
        Parameters:
        contextPath - The path of the context in which to query membership information.
      • ContextMembershipQuery

        public ContextMembershipQuery​(java.lang.String contextPath,
                                      ContextMembershipQuery.MembershipScope membershipScope)
        Constructor.
        Parameters:
        contextPath - The path of the context in which to query membership information.
        membershipScope - Indicates whether to include in the output the assigned members, defined groups, or all members at the specified context.
    • Method Detail

      • getMembershipScope

        public ContextMembershipQuery.MembershipScope getMembershipScope()
        Gets whether to include in the output the assigned members, defined groups, or all members at the specified context.
        Returns:
        Indicates whether to include in the output the assigned members, defined groups, or all members at the specified context.
      • setMembershipScope

        public void setMembershipScope​(ContextMembershipQuery.MembershipScope membershipScope)
        Sets whether to include in the output the assigned members, defined groups, or all members at the specified context.
        Parameters:
        membershipScope - Indicates whether to include in the output the assigned members, defined groups, or all members at the specified context.