Package com.ibm.wsspi.security.wim.model
Class GroupControl
- 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
 
 
 
 
 
- 
- Direct Known Subclasses:
- GroupMemberControl,- GroupMembershipControl
 
 public class GroupControl extends HierarchyControl Java class for GroupControl complex type. The following schema fragment specifies the expected content contained within this class. <complexType name="GroupControl"> <complexContent> <extension base="{http://www.ibm.com/websphere/wim}HierarchyControl"> <attribute name="modifyMode" type="{http://www.w3.org/2001/XMLSchema}int" default="1" /> </extension> </complexContent> </complexType>The GroupControl object extends the HierarchyControl object, and defines one property: modifyMode. The GroupControl object may 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: controls the number of members defined in a group object to be added as members of this group
- 1: this default setting will cause the members in the group object to be added to this group as its members
- 2: will cause the members contained in the group object to be added to the group as its members, and all 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.
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class com.ibm.wsspi.security.wim.model.PropertyControlPropertyControl.ContextProperties
 
- 
 - 
Constructor SummaryConstructors Constructor Description GroupControl()
 - 
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.intgetModifyMode()Gets the value of the modifyMode property.static java.util.ListgetPropertyNames(java.lang.String entityTypeName)Gets a list of all supported properties for this model object, GroupControlstatic java.util.HashSetgetSubTypes()Gets a set of any model objects which extend this model object, GroupControljava.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, GroupControl, is an extension of.java.lang.StringgetTypeName()Gets the name of this model object, GroupControlbooleanisSet(java.lang.String propName)Returns true if the requested property is set; false, otherwise.booleanisSetModifyMode()Returns true if the modifyMode 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.voidsetModifyMode(int value)Sets the value of the modifyMode property.java.lang.StringtoString()Returns this model object, GroupControl, and its contents as a Stringvoidunset(java.lang.String propName)Sets the value of provided property to null.voidunsetModifyMode()Resets the modifyMode property to null.- 
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- 
getModifyModepublic int getModifyMode() Gets the value of the modifyMode property.- Returns:
- possible object is Integer
 
 - 
setModifyModepublic void setModifyMode(int value) Sets the value of the modifyMode property.- Parameters:
- value- allowed object is- Integer
 
 - 
isSetModifyModepublic boolean isSetModifyMode() Returns true if the modifyMode property is set; false, otherwise.- Returns:
- returned object is boolean
 
 - 
unsetModifyModepublic void unsetModifyMode() Resets the modifyMode property to null.
 - 
getpublic java.lang.Object get(java.lang.String propName) Gets the value of the requested property- Overrides:
- getin class- HierarchyControl
- 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- HierarchyControl
- 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- HierarchyControl
- 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- HierarchyControl
- Parameters:
- propName- allowed object is- String
 
 - 
getTypeNamepublic java.lang.String getTypeName() Gets the name of this model object, GroupControl- Overrides:
- getTypeNamein class- HierarchyControl
- 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, GroupControl- 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- HierarchyControl
- 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, GroupControl, is an extension of.- Overrides:
- getSuperTypesin class- HierarchyControl
- 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- HierarchyControl
- 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, GroupControl- Returns:
- returned object is HashSet
 
 - 
toStringpublic java.lang.String toString() Returns this model object, GroupControl, and its contents as a String- Overrides:
- toStringin class- HierarchyControl
- Returns:
- returned object is String
 
 
- 
 
-