Package com.ibm.wsspi.security.wim.model

Class CheckGroupMembershipControl

java.lang.Object
com.ibm.wsspi.security.wim.model.Control
com.ibm.wsspi.security.wim.model.CheckGroupMembershipControl
public class CheckGroupMembershipControl extends Control

Java class for CheckGroupMembershipControl complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="CheckGroupMembershipControl">
 <complexContent>
 <extension base="{http://www.ibm.com/websphere/wim}Control">
 <attribute name="level" type="{http://www.w3.org/2001/XMLSchema}int" default="1" />
 <attribute name="inGroup" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
 </extension>
 </complexContent>
 </complexType>

The CheckGroupMembershipControl object extends the Control object and defines two properties: level and inGroup.

In order to check whether a group contains a member or not, the caller can issue the get() API call with one group object and one member object, and with the CheckGroupMembershipControl. The underlying repository will be checked and a boolean value will be returned in the CheckGroupMembershipControl object of the returned Root object to indicate the membership relationship, i.e, if the member is a part of the group.

  • level: indicates the level of members to be returned.
  • inGroup: indicates the result in the returned Root object after checking the group membership.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckGroupMembershipControl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    get(String propName)
    Gets the value of the requested property
    String
    getDataType(String propName)
    Gets the Java type of the value of the provided property.
    int
    getLevel()
    Gets the value of the level property.
    static List
    getPropertyNames(String entityTypeName)
    Gets a list of all supported properties for this model object, CheckGroupMembershipControl
    static HashSet
    getSubTypes()
    Gets a set of any model objects which extend this model object, CheckGroupMembershipControl
    ArrayList
    getSuperTypes()
    Gets a list of any model objects which this model object, CheckGroupMembershipControl, is an extension of.
    String
    getTypeName()
    Gets the name of this model object, CheckGroupMembershipControl
    boolean
    isInGroup()
    Gets the value of the inGroup property.
    boolean
    isSet(String propName)
    Returns true if the requested property is set; false, otherwise.
    boolean
    isSetInGroup()
    Returns true if the inGroup property is set; false, otherwise.
    boolean
    isSetLevel()
    Returns true if the level property is set; false, otherwise.
    boolean
    isSubType(String superTypeName)
    Returns a true if the provided model object is one that this model object extends; false, otherwise.
    void
    set(String propName, Object value)
    Sets the value of the provided property to the provided value.
    void
    setInGroup(boolean value)
    Sets the value of the inGroup property.
    void
    setLevel(int value)
    Sets the value of the level property.
    String
    toString()
    Returns this model object, CheckGroupMembershipControl, and its contents as a String
    void
    unset(String propName)
    Sets the value of provided property to null.
    void
    unsetInGroup()
    Resets the inGroup property to null.
    void
    unsetLevel()
    Resets the level property to null.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CheckGroupMembershipControl

      public CheckGroupMembershipControl()

  • Method Details

    • getLevel

      public int getLevel()
      Gets the value of the level property.
      Returns:
      possible object is Integer

    • setLevel

      public void setLevel(int value)
      Sets the value of the level property.
      Parameters:
      value - allowed object is Integer

    • isSetLevel

      public boolean isSetLevel()
      Returns true if the level property is set; false, otherwise.
      Returns:
      returned object is boolean

    • unsetLevel

      public void unsetLevel()
      Resets the level property to null.

    • isInGroup

      public boolean isInGroup()
      Gets the value of the inGroup property.
      Returns:
      possible object is Boolean

    • setInGroup

      public void setInGroup(boolean value)
      Sets the value of the inGroup property.
      Parameters:
      value - allowed object is Boolean

    • isSetInGroup

      public boolean isSetInGroup()
      Returns true if the inGroup property is set; false, otherwise.
      Returns:
      returned object is boolean

    • unsetInGroup

      public void unsetInGroup()
      Resets the inGroup property to null.

    • get

      public Object get(String propName)
      Gets the value of the requested property
      Overrides:
      get in class Control
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is Object

    • isSet

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

    • set

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

    • unset

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

    • getTypeName

      public String getTypeName()
      Gets the name of this model object, CheckGroupMembershipControl
      Overrides:
      getTypeName in class Control
      Returns:
      returned object is String

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, CheckGroupMembershipControl
      Parameters:
      entityTypeName - allowed object is String
      Returns:
      returned object is List

    • getDataType

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

    • getSuperTypes

      public ArrayList getSuperTypes()
      Gets a list of any model objects which this model object, CheckGroupMembershipControl, is an extension of.
      Overrides:
      getSuperTypes in class Control
      Returns:
      returned object is ArrayList

    • isSubType

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

    • getSubTypes

      public static HashSet getSubTypes()
      Gets a set of any model objects which extend this model object, CheckGroupMembershipControl
      Returns:
      returned object is HashSet

    • toString

      public String toString()
      Returns this model object, CheckGroupMembershipControl, and its contents as a String
      Overrides:
      toString in class Control
      Returns:
      returned object is String