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

Class Group

java.lang.Object
com.ibm.wsspi.security.wim.model.Entity
com.ibm.wsspi.security.wim.model.RolePlayer
com.ibm.wsspi.security.wim.model.Party
com.ibm.wsspi.security.wim.model.Group
public class Group extends Party

Java class for Group complex type.

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

 <complexType name="Group">
 <complexContent>
 <extension base="{http://www.ibm.com/websphere/wim}Party">
 <sequence>
 <element ref="{http://www.ibm.com/websphere/wim}cn"/>
 <element name="members" type="{http://www.ibm.com/websphere/wim}Entity" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}displayName" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}description" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}businessCategory" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}seeAlso" maxOccurs="unbounded" minOccurs="0"/>
 </sequence>
 </extension>
 </complexContent>
 </complexType>

The Group object extends the Party object and is used to define the properties of a group.

The Group object has several properties: cn, members, displayName, description, and businessCategory.

  • cn: represents the common name of the group.
  • members: references 0 to n Entity objects which are associated with this group. A member may be a reference to a Person or another Group entity.
  • displayName: references the full name associated with the group.
  • description: provides a means to describe the group.

  • Constructor Details

    • Group

      public Group()

  • Method Details

    • getCn

      public String getCn()
      Gets the value of the cn property.
      Returns:
      possible object is String

    • setCn

      public void setCn(String value)
      Sets the value of the cn property.
      Parameters:
      value - allowed object is String

    • isSetCn

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

    • getMembers

      public List<Entity> getMembers()
      Gets the value of the members property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the members property.

      For example, to add a new item, do as follows: 

       getMembers().add(newItem);

      Objects of the following type(s) are allowed in the list Entity

    • isSetMembers

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

    • unsetMembers

      public void unsetMembers()
      Resets the value of the members property to null

    • getDisplayName

      public List<String> getDisplayName()
      Gets the value of the displayName property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the displayName property.

      For example, to add a new item, do as follows: 

       getDisplayName().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetDisplayName

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

    • unsetDisplayName

      public void unsetDisplayName()
      Resets the value of the displayName property to null

    • getDescription

      public List<String> getDescription()
      Gets the value of the description property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

      For example, to add a new item, do as follows: 

       getDescription().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetDescription

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

    • unsetDescription

      public void unsetDescription()
      Resets the value of the description property to null

    • getBusinessCategory

      public List<String> getBusinessCategory()
      Gets the value of the businessCategory property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the businessCategory property.

      For example, to add a new item, do as follows: 

       getBusinessCategory().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetBusinessCategory

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

    • unsetBusinessCategory

      public void unsetBusinessCategory()
      Resets the value of the businessCategory property to null

    • getSeeAlso

      public List<String> getSeeAlso()
      Gets the value of the seeAlso property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the seeAlso property.

      For example, to add a new item, do as follows: 

       getSeeAlso().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • isSetSeeAlso

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

    • unsetSeeAlso

      public void unsetSeeAlso()
      Resets the value of the seeAlso property to null

    • get

      public Object get(String propName)
      Gets the value of the requested property
      Overrides:
      get in class Party
      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 Party
      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 Party
      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 Party
      Parameters:
      propName - allowed object is String

    • getTypeName

      public String getTypeName()
      Description copied from class: Entity
      Gets the name of this model object, Entity
      Overrides:
      getTypeName in class Party
      Returns:
      returned object is String

    • isMandatory

      public boolean isMandatory(String propName)
      Returns true if the provided property name is a mandatory property; false, otherwise.
      Overrides:
      isMandatory in class Party
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is boolean

    • isPersistentProperty

      public boolean isPersistentProperty(String propName)
      Returns true if the provided property name is a persistent property; false, otherwise.
      Overrides:
      isPersistentProperty in class Party
      Parameters:
      propName - allowed object is String
      Returns:
      returned object is boolean

    • reInitializePropertyNames

      public static void reInitializePropertyNames()

    • getPropertyNames

      public static List getPropertyNames(String entityTypeName)
      Gets a list of all supported properties for this model object, Group
      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 Party
      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, Group, is an extension of.
      Overrides:
      getSuperTypes in class Party
      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 Party
      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, Group
      Returns:
      returned object is HashSet

    • toString

      public String toString()
      Description copied from class: Entity
      Returns this model object, Entity, and its contents as a String
      Overrides:
      toString in class Party
      Returns:
      returned object is String

    • addExtendedProperty

      public static void addExtendedProperty(String propName, String dataType, boolean multiValued, Object defaultValue)
      Allows for an extended property, or a property not pre-defined as part of this Group entity type, to be added to the Group entity
      Parameters:
      propName - : name of property
      dataType - : Java type of property
      multiValued - : describes if the property is a single valued or multi-valued property
      • allowed object is a boolean
      defaultValue - : defines the default value for this property

    • clearExtendedProperties

      public static void clearExtendedProperties()
      Removes all extended properties defined in this Group entity

    • getExtendedPropertyNames

      public Set<String> getExtendedPropertyNames()
      Returns a list of extended property names added to this Group entity
      Returns:
      returned object is a Set

    • isMultiValuedProperty

      public boolean isMultiValuedProperty(String propName)
      Description copied from class: Entity
      Return whether the specified property is a multi-valued property and capable of holding multiple values.
      Overrides:
      isMultiValuedProperty in class RolePlayer
      Parameters:
      propName - The property name to check.
      Returns:
      True if the property is multi-value, false otherwise.