public class ContextMembershipQuery extends Query
Modifier and Type | Class and Description |
---|---|
static class |
ContextMembershipQuery.MembershipScope
The scope in which to query the membership.
|
Modifier and Type | Field and Description |
---|---|
static List<Column> |
ALL
The value that represents all columns in
ContextMembershipQuery . |
static Column |
CONTEXT_QUERIED
The column that represents the path of the context that was queried for membership information.
|
static Column |
EXPLICIT
The column that represents whether the member is explicit.
|
static Column |
GROUP_CONTEXT
The column that represents the context path in which the group member is defined.
|
static Column |
LEVEL
The column that represents the number of levels in which the member is nested as with groups of groups.
|
static Column |
LINEAGE
The column that represents the lineage of the location in which the member originated.
|
static Column |
PARENT_GROUP
The column that represents the name of the parent group, if it exists.
|
static Column |
PARENT_GROUP_CONTEXT
The column that represents the context path of the parent group, if it exists.
|
static Column |
PRINCIPAL_NAME
The column that represents the name of the member.
|
static Column |
PRINCIPAL_TYPE
The column that represents the type of member.
|
Constructor and Description |
---|
ContextMembershipQuery(String contextPath)
The constructor with all of the required fields.
|
ContextMembershipQuery(String contextPath,
ContextMembershipQuery.MembershipScope membershipScope)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getContextPath()
Gets the path of the context in which to query membership information.
|
ContextMembershipQuery.MembershipScope |
getMembershipScope()
Gets whether to include in the output the assigned members, defined groups, or all members at the specified
context.
|
void |
setMembershipScope(ContextMembershipQuery.MembershipScope membershipScope)
Sets whether to include in the output the assigned members, defined groups, or all members at the specified
context.
|
constrain, getColumns, getConstraint, getOrder, includeColumnNames, isIncludeColumnNames, order, order, select, select, setColumns, setConstraint, setIncludeColumnNames, setOrder, toString
public static final Column CONTEXT_QUERIED
public static final Column PRINCIPAL_NAME
public static final Column LEVEL
public static final Column LINEAGE
public static final Column PRINCIPAL_TYPE
public static final Column EXPLICIT
public static final Column GROUP_CONTEXT
public static final Column PARENT_GROUP
public static final Column PARENT_GROUP_CONTEXT
public ContextMembershipQuery(String contextPath)
includeGroupMembers is false.
contextPath
- The path of the context in which to query membership information.public ContextMembershipQuery(String contextPath, ContextMembershipQuery.MembershipScope membershipScope)
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.public String getContextPath()
public ContextMembershipQuery.MembershipScope getMembershipScope()
public void setMembershipScope(ContextMembershipQuery.MembershipScope membershipScope)
membershipScope
- Indicates whether to include in the output the assigned members, defined groups, or all
members at the specified context.<i>Copyright (c) 2020, SAS Institute Inc., Cary, NC, USA</i>