Class Group
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidaddExtendedProperty(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 entitystatic voidRemoves all extended properties defined in this Group entityGets the value of the requested propertyGets the value of the businessCategory property.getCn()Gets the value of the cn property.getDataType(String propName) Gets the Java type of the value of the provided property.Gets the value of the description property.Gets the value of the displayName property.Returns a list of extended property names added to this Group entityGets the value of the members property.static ListgetPropertyNames(String entityTypeName) Gets a list of all supported properties for this model object, GroupGets the value of the seeAlso property.static HashSetGets a set of any model objects which extend this model object, GroupGets a list of any model objects which this model object, Group, is an extension of.Gets the name of this model object, EntitybooleanisMandatory(String propName) Returns true if the provided property name is a mandatory property; false, otherwise.booleanisMultiValuedProperty(String propName) Return whether the specified property is a multi-valued property and capable of holding multiple values.booleanisPersistentProperty(String propName) Returns true if the provided property name is a persistent property; false, otherwise.booleanReturns true if the requested property is set; false, otherwise.booleanReturns true if the businessCategory property is set; false, otherwise.booleanisSetCn()Returns true if the cn property is set; false, otherwise.booleanReturns true if the description property is set; false, otherwise.booleanReturns true if the displayName property is set; false, otherwise.booleanReturns true if the members property is set; false, otherwise.booleanReturns true if the seeAlso property is set; false, otherwise.booleanReturns a true if the provided model object is one that this model object extends; false, otherwise.static voidvoidSets the value of the provided property to the provided value.voidSets the value of the cn property.toString()Returns this model object, Entity, and its contents as a StringvoidSets the value of provided property to null.voidResets the value of the businessCategory property to nullvoidResets the value of the description property to nullvoidResets the value of the displayName property to nullvoidResets the value of the members property to nullvoidResets the value of the seeAlso property to nullMethods inherited from class com.ibm.wsspi.security.wim.model.RolePlayer
getPartyRoles, isSetPartyRoles, unsetPartyRolesMethods inherited from class com.ibm.wsspi.security.wim.model.Entity
getChangeType, 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
-
Constructor Details
-
Group
public Group()
-
-
Method Details
-
getCn
Gets the value of the cn property.- Returns:
- possible object is
String
-
setCn
Sets the value of the cn property.- Parameters:
value- allowed object isString
-
isSetCn
public boolean isSetCn()Returns true if the cn property is set; false, otherwise.- Returns:
- returned object is
boolean
-
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 -
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
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 -
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
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 -
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
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 -
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
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 -
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
Gets the value of the requested property -
isSet
Returns true if the requested property is set; false, otherwise. -
set
Sets the value of the provided property to the provided value. -
unset
Sets the value of provided property to null. -
getTypeName
Description copied from class:EntityGets the name of this model object, Entity- Overrides:
getTypeNamein classParty- Returns:
- returned object is
String
-
isMandatory
Returns true if the provided property name is a mandatory property; false, otherwise.- Overrides:
isMandatoryin classParty- Parameters:
propName- allowed object isString- Returns:
- returned object is
boolean
-
isPersistentProperty
Returns true if the provided property name is a persistent property; false, otherwise.- Overrides:
isPersistentPropertyin classParty- Parameters:
propName- allowed object isString- Returns:
- returned object is
boolean
-
reInitializePropertyNames
public static void reInitializePropertyNames() -
getPropertyNames
Gets a list of all supported properties for this model object, Group -
getDataType
Gets the Java type of the value of the provided property. For example: String, List- Overrides:
getDataTypein classParty- Parameters:
propName- allowed object isString- Returns:
- returned object is
String
-
getSuperTypes
Gets a list of any model objects which this model object, Group, is an extension of.- Overrides:
getSuperTypesin classParty- Returns:
- returned object is
ArrayList
-
isSubType
Returns a true if the provided model object is one that this model object extends; false, otherwise. -
getSubTypes
Gets a set of any model objects which extend this model object, Group- Returns:
- returned object is
HashSet
-
toString
Description copied from class:EntityReturns this model object, Entity, and its contents as a 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- 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
-
clearExtendedProperties
public static void clearExtendedProperties()Removes all extended properties defined in this Group entity -
getExtendedPropertyNames
Returns a list of extended property names added to this Group entity- Returns:
- returned object is a
Set
-
isMultiValuedProperty
Description copied from class:EntityReturn whether the specified property is a multi-valued property and capable of holding multiple values.- Overrides:
isMultiValuedPropertyin classRolePlayer- Parameters:
propName- The property name to check.- Returns:
- True if the property is multi-value, false otherwise.
-