public class GroupMembershipControl extends GroupControl
Java class for GroupMembershipControl complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="GroupMembershipControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}GroupControl"> </extension> </complexContent> </complexType>
The GroupMembershipControl object extends from the abstract GroupControl object.
The GroupControl DataObject contains the following properties that are inherited by GroupMembershipControl: level, properties, searchBases, countLimit, timeLimit, modifyMode and expression.
GroupMembershipControl is used in the input Root object of both the get() API and update() API.
In the get() API, GroupMembershipControl is used for requesting the groups to which an entity belongs. If theGroupMembershipControl is added to the input Root object, then the groups the entity belongs to will be returned.
GroupMembershipControl can also be used for specifying the properties to be returned for groups as well as the level of nested groups to be returned.
In an update() API call, GroupMembershipControl can be used to specify the assign or un-assign mode through the modifyMode property.
Since GroupMembershipControl is also extended from SearchControl, you can specify property expression and other search properties like countLimit, and timeLimit in GroupMembershipControl to only return those groups which satisfy the search criteria. For example, it is possible to add the property expression with value: @xsi:type='Group' and cn='Admin*' to only return those groups whose cn property starts with Admin.
PropertyControl.ContextProperties
Constructor and Description |
---|
GroupMembershipControl() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
get(java.lang.String propName)
Gets the value of the requested property
|
java.lang.String |
getDataType(java.lang.String propName)
Gets the Java type of the value of the provided property.
|
static java.util.List |
getPropertyNames(java.lang.String entityTypeName)
Gets a list of all supported properties for this model object, GroupMembershipControl
|
static java.util.HashSet |
getSubTypes()
Gets a set of any model objects which extend this model object, GroupMembershipControl
|
java.util.ArrayList |
getSuperTypes()
Gets a list of any model objects which this model object, GroupMembershipControl, is
an extension of.
|
java.lang.String |
getTypeName()
Gets the name of this model object, GroupMembershipControl
|
boolean |
isSet(java.lang.String propName)
Returns true if the requested property is set; false, otherwise.
|
boolean |
isSubType(java.lang.String superTypeName)
Returns a true if the provided model object is one that this
model object extends; false, otherwise.
|
void |
set(java.lang.String propName,
java.lang.Object value)
Sets the value of the provided property to the provided value.
|
java.lang.String |
toString()
Returns this model object, GroupMembershipControl, and its contents as a String
|
void |
unset(java.lang.String propName)
Sets the value of provided property to null.
|
getModifyMode, isSetModifyMode, setModifyMode, unsetModifyMode
getLevel, isSetLevel, isSetTreeView, isTreeView, setLevel, setTreeView, unsetLevel, unsetTreeView
getCountLimit, getExpression, getSearchBases, getSearchLimit, getTimeLimit, isReturnSubType, isSetCountLimit, isSetExpression, isSetReturnSubType, isSetSearchBases, isSetSearchLimit, isSetTimeLimit, setCountLimit, setExpression, setReturnSubType, setSearchLimit, setTimeLimit, unsetCountLimit, unsetReturnSubType, unsetSearchBases, unsetSearchLimit, unsetTimeLimit
getContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
public java.lang.Object get(java.lang.String propName)
get
in class GroupControl
propName
- allowed object is String
Object
public boolean isSet(java.lang.String propName)
isSet
in class GroupControl
boolean
public void set(java.lang.String propName, java.lang.Object value)
set
in class GroupControl
propName
- allowed object is String
value
- allowed object is Object
public void unset(java.lang.String propName)
unset
in class GroupControl
propName
- allowed object is String
public java.lang.String getTypeName()
getTypeName
in class GroupControl
String
public static java.util.List getPropertyNames(java.lang.String entityTypeName)
entityTypeName
- allowed object is String
List
public java.lang.String getDataType(java.lang.String propName)
getDataType
in class GroupControl
propName
- allowed object is String
String
public java.util.ArrayList getSuperTypes()
getSuperTypes
in class GroupControl
ArrayList
public boolean isSubType(java.lang.String superTypeName)
isSubType
in class GroupControl
superTypeName
- allowed object is String
boolean
public static java.util.HashSet getSubTypes()
HashSet
public java.lang.String toString()
toString
in class GroupControl
String