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 SummaryConstructors Constructor Description Group()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static voidaddExtendedProperty(java.lang.String propName, java.lang.String dataType, boolean multiValued, java.lang.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 entitystatic voidclearExtendedProperties()Removes all extended properties defined in this Group entityjava.lang.Objectget(java.lang.String propName)Gets the value of the requested propertyjava.util.List<java.lang.String>getBusinessCategory()Gets the value of the businessCategory property.java.lang.StringgetCn()Gets the value of the cn property.java.lang.StringgetDataType(java.lang.String propName)Gets the Java type of the value of the provided property.java.util.List<java.lang.String>getDescription()Gets the value of the description property.java.util.List<java.lang.String>getDisplayName()Gets the value of the displayName property.java.util.Set<java.lang.String>getExtendedPropertyNames()Returns a list of extended property names added to this Group entityjava.util.List<Entity>getMembers()Gets the value of the members property.static java.util.ListgetPropertyNames(java.lang.String entityTypeName)Gets a list of all supported properties for this model object, Groupjava.util.List<java.lang.String>getSeeAlso()Gets the value of the seeAlso property.static java.util.HashSetgetSubTypes()Gets a set of any model objects which extend this model object, Groupjava.util.ArrayListgetSuperTypes()Gets a list of any model objects which this model object, Group, is an extension of.java.lang.StringgetTypeName()Gets the name of this model object, EntitybooleanisMandatory(java.lang.String propName)Returns true if the provided property name is a mandatory property; false, otherwise.booleanisMultiValuedProperty(java.lang.String propName)Return whether the specified property is a multi-valued property and capable of holding multiple values.booleanisPersistentProperty(java.lang.String propName)Returns true if the provided property name is a persistent property; false, otherwise.booleanisSet(java.lang.String propName)Returns true if the requested property is set; false, otherwise.booleanisSetBusinessCategory()Returns true if the businessCategory property is set; false, otherwise.booleanisSetCn()Returns true if the cn property is set; false, otherwise.booleanisSetDescription()Returns true if the description property is set; false, otherwise.booleanisSetDisplayName()Returns true if the displayName property is set; false, otherwise.booleanisSetMembers()Returns true if the members property is set; false, otherwise.booleanisSetSeeAlso()Returns true if the seeAlso 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.static voidreInitializePropertyNames()voidset(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.voidsetCn(java.lang.String value)Sets the value of the cn property.java.lang.StringtoString()Returns this model object, Entity, and its contents as a Stringvoidunset(java.lang.String propName)Sets the value of provided property to null.voidunsetBusinessCategory()Resets the value of the businessCategory property to nullvoidunsetDescription()Resets the value of the description property to nullvoidunsetDisplayName()Resets the value of the displayName property to nullvoidunsetMembers()Resets the value of the members property to nullvoidunsetSeeAlso()Resets the value of the seeAlso property to null- 
Methods inherited from class com.ibm.wsspi.security.wim.model.RolePlayergetPartyRoles, isSetPartyRoles, unsetPartyRoles
 - 
Methods inherited from class com.ibm.wsspi.security.wim.model.EntitygetChangeType, getChildren, getCreateTimestamp, getEntitlementInfo, getGroups, getIdentifier, getModifyTimestamp, getParent, getSubEntityTypes, getViewIdentifiers, isSetChangeType, isSetChildren, isSetCreateTimestamp, isSetEntitlementInfo, isSetGroups, isSetIdentifier, isSetModifyTimestamp, isSetParent, isSetViewIdentifiers, isUnset, setChangeType, setCreateTimestamp, setEntitlementInfo, setIdentifier, setModifyTimestamp, setParent, unsetChildren, unsetGroups, unsetViewIdentifiers
 
- 
 
- 
- 
- 
Method Detail- 
getCnpublic java.lang.String getCn() Gets the value of the cn property.- Returns:
- possible object is String
 
 - 
setCnpublic void setCn(java.lang.String value) Sets the value of the cn property.- Parameters:
- value- allowed object is- String
 
 - 
isSetCnpublic boolean isSetCn() Returns true if the cn property is set; false, otherwise.- Returns:
- returned object is boolean
 
 - 
getMemberspublic java.util.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 setmethod 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
 - 
isSetMemberspublic boolean isSetMembers() Returns true if the members property is set; false, otherwise.- Returns:
- returned object is boolean
 
 - 
unsetMemberspublic void unsetMembers() Resets the value of the members property to null
 - 
getDisplayNamepublic java.util.List<java.lang.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 setmethod 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
 - 
isSetDisplayNamepublic boolean isSetDisplayName() Returns true if the displayName property is set; false, otherwise.- Returns:
- returned object is boolean
 
 - 
unsetDisplayNamepublic void unsetDisplayName() Resets the value of the displayName property to null
 - 
getDescriptionpublic java.util.List<java.lang.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 setmethod 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
 - 
isSetDescriptionpublic boolean isSetDescription() Returns true if the description property is set; false, otherwise.- Returns:
- returned object is boolean
 
 - 
unsetDescriptionpublic void unsetDescription() Resets the value of the description property to null
 - 
getBusinessCategorypublic java.util.List<java.lang.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 setmethod 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
 - 
isSetBusinessCategorypublic boolean isSetBusinessCategory() Returns true if the businessCategory property is set; false, otherwise.- Returns:
- returned object is boolean
 
 - 
unsetBusinessCategorypublic void unsetBusinessCategory() Resets the value of the businessCategory property to null
 - 
getSeeAlsopublic java.util.List<java.lang.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 setmethod 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
 - 
isSetSeeAlsopublic boolean isSetSeeAlso() Returns true if the seeAlso property is set; false, otherwise.- Returns:
- returned object is boolean
 
 - 
unsetSeeAlsopublic void unsetSeeAlso() Resets the value of the seeAlso property to null
 - 
getpublic java.lang.Object get(java.lang.String propName) Gets the value of the requested property
 - 
isSetpublic boolean isSet(java.lang.String propName) Returns true if the requested property is set; false, otherwise.
 - 
setpublic void set(java.lang.String propName, java.lang.Object value)Sets the value of the provided property to the provided value.
 - 
unsetpublic void unset(java.lang.String propName) Sets the value of provided property to null.
 - 
getTypeNamepublic java.lang.String getTypeName() Description copied from class:EntityGets the name of this model object, Entity- Overrides:
- getTypeNamein class- Party
- Returns:
- returned object is String
 
 - 
isMandatorypublic boolean isMandatory(java.lang.String propName) Returns true if the provided property name is a mandatory property; false, otherwise.- Overrides:
- isMandatoryin class- Party
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is boolean
 
 - 
isPersistentPropertypublic boolean isPersistentProperty(java.lang.String propName) Returns true if the provided property name is a persistent property; false, otherwise.- Overrides:
- isPersistentPropertyin class- Party
- Parameters:
- propName- allowed object is- String
- Returns:
- returned object is boolean
 
 - 
reInitializePropertyNamespublic static void reInitializePropertyNames() 
 - 
getPropertyNamespublic static java.util.List getPropertyNames(java.lang.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
 
 - 
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- Party
- 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, Group, is an extension of.- Overrides:
- getSuperTypesin class- Party
- 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.
 - 
getSubTypespublic static java.util.HashSet getSubTypes() Gets a set of any model objects which extend this model object, Group- Returns:
- returned object is HashSet
 
 - 
toStringpublic java.lang.String toString() Description copied from class:EntityReturns this model object, Entity, and its contents as a String
 - 
addExtendedPropertypublic static void addExtendedProperty(java.lang.String propName, java.lang.String dataType, boolean multiValued, java.lang.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- allowed object is a String
 
- allowed object is a 
- dataType- : Java type of property- allowed object is a String
 
- allowed object is a 
- multiValued- : describes if the property is a single valued or multi-valued property- allowed object is a boolean
 
- allowed object is a 
- defaultValue- : defines the default value for this property- allowed object is a Object
 
- allowed object is a 
 
 - 
clearExtendedPropertiespublic static void clearExtendedProperties() Removes all extended properties defined in this Group entity
 - 
getExtendedPropertyNamespublic java.util.Set<java.lang.String> getExtendedPropertyNames() Returns a list of extended property names added to this Group entity- Returns:
- returned object is a Set
 
 - 
isMultiValuedPropertypublic boolean isMultiValuedProperty(java.lang.String propName) Description copied from class:EntityReturn whether the specified property is a multi-valued property and capable of holding multiple values.- Overrides:
- isMultiValuedPropertyin class- RolePlayer
- Parameters:
- propName- The property name to check.
- Returns:
- True if the property is multi-value, false otherwise.
 
 
- 
 
-