Class GroupMemberControl
- java.lang.Object
- 
 public class GroupMemberControl extends GroupControl Java class for GroupMemberControl complex type. The following schema fragment specifies the expected content contained within this class. <complexType name="GroupMemberControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}GroupControl"> </extension> </complexContent> </complexType>The GroupMemberControl object extends the abstract GroupControl object. The GroupControl object contains the following properties that are inherited by GroupMemberControl: level, properties, searchBases, countLimit, timeLimit, expression, treeView, and modifyMode. GroupMemberControl is used in the input Root object of both the get() and update() APIs. In the get() API, it is used for requesting members of this group. If it is added to the input Root object, it indicates the members of group that will be returned. GroupMemberControl can also be used to specify the properties to be returned for members as well as the level of nested members to be returned. - level
 - 0: will return all nested members
- 1: will cause only the immediate members to be returned. This is the default value.
- greater than 1: will return the specified level number of members. For example, a level of 2 will return immediate members and their immediate members.
 
 In the update() API, GroupMembersControl can be used to specify the assign or un-assign mode through the modifyMode property. Multiple entities can be assigned or un-assigned in a single call. If there is only partial success when assigning or un-assigning multiple entities, an exception will be thrown. It is responsibility of the caller to perform any clean-up needed in the event of an exception. - modifyMode
 - 1: will cause the members in the group object to be added to this group as its members. This is the default setting.
- 2: will cause the members contained in the group object to be added to the group as its members, and all of the existing members of the group will be removed.
- 3: will cause the members contained in the group object to be un-assigned from the group.
 
 Since GroupMemberControl is also extended from SearchControl, it is possible to specify the property expression and other search properties like countLimit, and timeLimit in GroupMemberControl to only return those members which satisfy the search criteria. For example, the property expression with value: @xsi:type='Person' will only return the members which are of the Person entity type. - treeView: used for indicating whether the hierarchy of the nested members should be kept in the output Root object or not. If it is set to true, hierarchy relationship of the immediate members and nested members of different levels are kept in the Root object. If it is set to false, all members are put in a flat structure by pointing to the same members property of the group.
 
- level
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class com.ibm.wsspi.security.wim.model.PropertyControlPropertyControl.ContextProperties
 
- 
 - 
Constructor SummaryConstructors Constructor Description GroupMemberControl()
 - 
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, GroupMemberControlstatic java.util.HashSetgetSubTypes()Gets a set of any model objects which extend this model object, GroupMemberControljava.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, GroupMemberControl, is an extension of.java.lang.StringgetTypeName()Gets the name of this model object, GroupMemberControlbooleanisSet(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, GroupMemberControl, 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, GroupMemberControl- 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, GroupMemberControl- 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, GroupMemberControl, 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, GroupMemberControl- Returns:
- returned object is HashSet
 
 - 
toStringpublic java.lang.String toString() Returns this model object, GroupMemberControl, and its contents as a String- Overrides:
- toStringin class- GroupControl
- Returns:
- returned object is String
 
 
- 
 
-