com.ibm.wsspi.security.wim.model

Class 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.
    • Constructor Detail

      • GroupControl

        public GroupControl()
    • Method Detail

      • getModifyMode

        public int getModifyMode()
        Gets the value of the modifyMode property.
        Returns:
        possible object is Integer
      • setModifyMode

        public void setModifyMode(int value)
        Sets the value of the modifyMode property.
        Parameters:
        value - allowed object is Integer
      • isSetModifyMode

        public boolean isSetModifyMode()
        Returns true if the modifyMode property is set; false, otherwise.
        Returns:
        returned object is boolean
      • unsetModifyMode

        public void unsetModifyMode()
        Resets the modifyMode property to null.
      • get

        public java.lang.Object get(java.lang.String propName)
        Gets the value of the requested property
        Overrides:
        get in class HierarchyControl
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is Object
      • isSet

        public boolean isSet(java.lang.String propName)
        Returns true if the requested property is set; false, otherwise.
        Overrides:
        isSet in class HierarchyControl
        Returns:
        returned object is boolean
      • set

        public void set(java.lang.String propName,
               java.lang.Object value)
        Sets the value of the provided property to the provided value.
        Overrides:
        set in class HierarchyControl
        Parameters:
        propName - allowed object is String
        value - allowed object is Object
      • unset

        public void unset(java.lang.String propName)
        Sets the value of provided property to null.
        Overrides:
        unset in class HierarchyControl
        Parameters:
        propName - allowed object is String
      • getTypeName

        public java.lang.String getTypeName()
        Gets the name of this model object, GroupControl
        Overrides:
        getTypeName in class HierarchyControl
        Returns:
        returned object is String
      • getPropertyNames

        public 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
      • getDataType

        public java.lang.String getDataType(java.lang.String propName)
        Gets the Java type of the value of the provided property. For example: String, List
        Overrides:
        getDataType in class HierarchyControl
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is String
      • getSuperTypes

        public java.util.ArrayList getSuperTypes()
        Gets a list of any model objects which this model object, GroupControl, is an extension of.
        Overrides:
        getSuperTypes in class HierarchyControl
        Returns:
        returned object is ArrayList
      • isSubType

        public boolean isSubType(java.lang.String superTypeName)
        Returns a true if the provided model object is one that this model object extends; false, otherwise.
        Overrides:
        isSubType in class HierarchyControl
        Parameters:
        superTypeName - allowed object is String
        Returns:
        returned object is boolean
      • getSubTypes

        public static java.util.HashSet getSubTypes()
        Gets a set of any model objects which extend this model object, GroupControl
        Returns:
        returned object is HashSet
      • toString

        public java.lang.String toString()
        Returns this model object, GroupControl, and its contents as a String
        Overrides:
        toString in class HierarchyControl
        Returns:
        returned object is String