Class GroupMembershipControl
- java.lang.Object
- 
- com.ibm.wsspi.security.wim.model.Control
- 
- com.ibm.wsspi.security.wim.model.PropertyControl
- 
- com.ibm.wsspi.security.wim.model.SearchControl
- 
- com.ibm.wsspi.security.wim.model.HierarchyControl
- 
- com.ibm.wsspi.security.wim.model.GroupControl
- 
- com.ibm.wsspi.security.wim.model.GroupMembershipControl
 
 
 
 
 
 
- 
 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. - level
 - 0: will return all nested groups
- 1: will cause only the immediate groups to be returned. This is the default value.
- greater than 1: will return the specified level number of groups. For example, a level of 2 will return immediate groups and their immediate groups.
 
 In an update() API call, GroupMembershipControl can be used to specify the assign or un-assign mode through the modifyMode property. - modifyMode
 - 1: the groups contained in the entity object will add the entity as their members. This is the default setting.
- 2: the groups contained in the entity object will add the entity as their members and all the existing members will be removed.
- 3: the groups contained in the entity object will remove the entity from their members.
 
 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. 
- treeView: used to indicate whether the hierarchy of the nested groups should be kept in the output Root object or not. If it is set to true, the hierarchy relationship of the immediate groups and nested groups of different levels are kept in the Root object. If it is set to false, all groups are put in a flat structure by pointing to the same groups property of the entity.
- level
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class com.ibm.wsspi.security.wim.model.PropertyControlPropertyControl.ContextProperties
 
- 
 - 
Constructor SummaryConstructors Constructor Description GroupMembershipControl()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Objectget(java.lang.String propName)Gets the value of the requested propertyjava.lang.StringgetDataType(java.lang.String propName)Gets the Java type of the value of the provided property.static java.util.ListgetPropertyNames(java.lang.String entityTypeName)Gets a list of all supported properties for this model object, GroupMembershipControlstatic java.util.HashSetgetSubTypes()Gets a set of any model objects which extend this model object, GroupMembershipControljava.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, GroupMembershipControl, is an extension of.java.lang.StringgetTypeName()Gets the name of this model object, GroupMembershipControlbooleanisSet(java.lang.String propName)Returns true if the requested property is set; false, otherwise.booleanisSubType(java.lang.String superTypeName)Returns a true if the provided model object is one that this model object extends; false, otherwise.voidset(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.java.lang.StringtoString()Returns this model object, GroupMembershipControl, and its contents as a Stringvoidunset(java.lang.String propName)Sets the value of provided property to null.- 
Methods inherited from class com.ibm.wsspi.security.wim.model.GroupControlgetModifyMode, isSetModifyMode, setModifyMode, unsetModifyMode
 - 
Methods inherited from class com.ibm.wsspi.security.wim.model.HierarchyControlgetLevel, isSetLevel, isSetTreeView, isTreeView, setLevel, setTreeView, unsetLevel, unsetTreeView
 - 
Methods inherited from class com.ibm.wsspi.security.wim.model.SearchControlgetCountLimit, getExpression, getSearchBases, getSearchLimit, getTimeLimit, isReturnSubType, isSetCountLimit, isSetExpression, isSetReturnSubType, isSetSearchBases, isSetSearchLimit, isSetTimeLimit, setCountLimit, setExpression, setReturnSubType, setSearchLimit, setTimeLimit, unsetCountLimit, unsetReturnSubType, unsetSearchBases, unsetSearchLimit, unsetTimeLimit
 - 
Methods inherited from class com.ibm.wsspi.security.wim.model.PropertyControlgetContextProperties, getProperties, isSetContextProperties, isSetProperties, unsetContextProperties, unsetProperties
 
- 
 
- 
- 
- 
Method Detail- 
getpublic java.lang.Object get(java.lang.String propName) Gets the value of the requested property- Overrides:
- getin class- GroupControl
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is Object
 
 - 
isSetpublic boolean isSet(java.lang.String propName) Returns true if the requested property is set; false, otherwise.- Overrides:
- isSetin class- GroupControl
- Returns:
- returned object is boolean
 
 - 
setpublic void set(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.- Overrides:
- setin class- GroupControl
- Parameters:
- propName- allowed object is- String
- value- allowed object is- Object
 
 - 
unsetpublic void unset(java.lang.String propName) Sets the value of provided property to null.- Overrides:
- unsetin class- GroupControl
- Parameters:
- propName- allowed object is- String
 
 - 
getTypeNamepublic java.lang.String getTypeName() Gets the name of this model object, GroupMembershipControl- Overrides:
- getTypeNamein class- GroupControl
- Returns:
- returned object is String
 
 - 
getPropertyNamespublic static java.util.List getPropertyNames(java.lang.String entityTypeName) Gets a list of all supported properties for this model object, GroupMembershipControl- Parameters:
- entityTypeName- allowed object is- String
- Returns:
- returned object is List
 
 - 
getDataTypepublic java.lang.String getDataType(java.lang.String propName) Gets the Java type of the value of the provided property. For example: String, List- Overrides:
- getDataTypein class- GroupControl
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is String
 
 - 
getSuperTypespublic java.util.ArrayList getSuperTypes() Gets a list of any model objects which this model object, GroupMembershipControl, is an extension of.- Overrides:
- getSuperTypesin class- GroupControl
- Returns:
- returned object is ArrayList
 
 - 
isSubTypepublic boolean isSubType(java.lang.String superTypeName) Returns a true if the provided model object is one that this model object extends; false, otherwise.- Overrides:
- isSubTypein class- GroupControl
- Parameters:
- superTypeName- allowed object is- String
- Returns:
- returned object is boolean
 
 - 
getSubTypespublic static java.util.HashSet getSubTypes() Gets a set of any model objects which extend this model object, GroupMembershipControl- Returns:
- returned object is HashSet
 
 - 
toStringpublic java.lang.String toString() Returns this model object, GroupMembershipControl, and its contents as a String- Overrides:
- toStringin class- GroupControl
- Returns:
- returned object is String
 
 
- 
 
-