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.
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.
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.
PropertyControl.ContextProperties
Constructor and Description |
---|
GroupMemberControl() |
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, GroupMemberControl
|
static java.util.HashSet |
getSubTypes()
Gets a set of any model objects which extend this model object, GroupMemberControl
|
java.util.ArrayList |
getSuperTypes()
Gets a list of any model objects which this model object, GroupMemberControl, is
an extension of.
|
java.lang.String |
getTypeName()
Gets the name of this model object, GroupMemberControl
|
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, GroupMemberControl, 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