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

Class Entity

java.lang.Object
com.ibm.wsspi.security.wim.model.Entity
Direct Known Subclasses:
Container, GeographicLocation, RolePlayer
public class Entity extends Object

Java class for Entity complex type.

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

 <complexType name="Entity">
 <complexContent>
 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 <sequence>
 <element name="identifier" type="{http://www.ibm.com/websphere/wim}IdentifierType" minOccurs="0"/>
 <element name="viewIdentifiers" type="{http://www.ibm.com/websphere/wim}ViewIdentifierType" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}parent" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}children" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}groups" maxOccurs="unbounded" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}createTimestamp" minOccurs="0"/>
 <element ref="{http://www.ibm.com/websphere/wim}modifyTimestamp" minOccurs="0"/>
 <element name="entitlementInfo" type="{http://www.ibm.com/websphere/wim}EntitlementInfoType" minOccurs="0"/>
 <element name="changeType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
 </sequence>
 </restriction>
 </complexContent>
 </complexType>

The Entity object represents a VMM entity. All other entity types, like Person, Group, and OrgContainer are extended from this Entity object.

The Entity object has several properties: identifier, viewIdentifiers, entitlementInfo, and changeType, each of which are represented themselves by objects.

  • identifier: contains a single IdentifierType object.
  • viewIdentifiers: contains a list of ViewIdentifierType objects.
  • parent: a containment property which is used to link to the parent of the entity in the VMM hierarchy. It only contains a single Entity object since an entity can only have one parent. Also, since any entity can be a parent of any entity, the object in the property is of Entity type.
  • children: a containment property which is used to link to the children of the entity in the VMM hierarchy. It contains multiple Entity objects since an entity can have multiple children. Also, since any entity can be a child of another entity, the object in the property is of Entity type.
  • groups: a containment property which is used to link to the groups this entity belongs to. It contains multiple Group objects since an entity can belong to multiple groups.
  • createTimestamp: indicates when the Entity was created.
  • modifyTimestamp: indicates when the Entity was last modified.
  • changeType: indicates the operation being performed on this Entity: add, delete, modify or rename.

  • Constructor Details

    • Entity

      public Entity()

  • Method Details

    • getIdentifier

      public IdentifierType getIdentifier()
      Gets the value of the identifier property.
      Returns:
      possible object is IdentifierType

    • setIdentifier

      public void setIdentifier(IdentifierType value)
      Sets the value of the identifier property.
      Parameters:
      value - allowed object is IdentifierType

    • isSetIdentifier

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

    • getViewIdentifiers

      public List<ViewIdentifierType> getViewIdentifiers()
      Gets the value of the viewIdentifiers 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 viewIdentifiers property.

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

       getViewIdentifiers().add(newItem);

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

    • isSetViewIdentifiers

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

    • unsetViewIdentifiers

      public void unsetViewIdentifiers()
      Resets the viewIdentifiers property to null.

    • getParent

      public Entity getParent()
      Gets the value of the parent property.
      Returns:
      possible object is Entity

    • setParent

      public void setParent(Entity value)
      Sets the value of the parent property.
      Parameters:
      value - allowed object is Entity

    • isSetParent

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

    • getChildren

      public List<Entity> getChildren()
      Gets the value of the children 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 children property.

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

       getChildren().add(newItem);

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

    • isSetChildren

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

    • unsetChildren

      public void unsetChildren()
      Resets the children property to null.

    • getGroups

      public List<Group> getGroups()
      Gets the value of the groups 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 groups property.

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

       getGroups().add(newItem);

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

    • isSetGroups

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

    • unsetGroups

      public void unsetGroups()
      Resets the groups property to null.

    • getCreateTimestamp

      public Date getCreateTimestamp()
      Gets the value of the createTimestamp property.
      Returns:
      possible object is Date

    • setCreateTimestamp

      public void setCreateTimestamp(Date value)
      Sets the value of the createTimestamp property.
      Parameters:
      value - allowed object is Date

    • isSetCreateTimestamp

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

    • getModifyTimestamp

      public Date getModifyTimestamp()
      Gets the value of the modifyTimestamp property.
      Returns:
      possible object is Date

    • setModifyTimestamp

      public void setModifyTimestamp(Date value)
      Sets the value of the modifyTimestamp property.
      Parameters:
      value - allowed object is Date

    • isSetModifyTimestamp

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

    • getEntitlementInfo

      public EntitlementInfoType getEntitlementInfo()
      Gets the value of the entitlementInfo property.
      Returns:
      possible object is EntitlementInfoType

    • setEntitlementInfo

      public void setEntitlementInfo(EntitlementInfoType value)
      Sets the value of the entitlementInfo property.
      Parameters:
      value - allowed object is EntitlementInfoType

    • isSetEntitlementInfo

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

    • getChangeType

      public String getChangeType()
      Gets the value of the changeType property.
      Returns:
      possible object is String

    • setChangeType

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

    • isSetChangeType

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

    • get

      public Object get(String propName)
      Gets the value of the requested property
      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.
      Returns:
      returned object is boolean

    • set

      public void set(String propName, Object value)
      Sets the value of the provided property to the provided value.
      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.
      Parameters:
      propName - allowed object is String

    • getTypeName

      public String getTypeName()
      Gets the name of this model object, Entity
      Returns:
      returned object is String

    • isMandatory

      public boolean isMandatory(String propName)
      Returns true if the provided property is a mandatory property; false, otherwise.
      Returns:
      returned object is boolean

    • isPersistentProperty

      public boolean isPersistentProperty(String propName)
      Returns true if the provided property is a persistent property; false, otherwise.
      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, Entity
      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
      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, Entity, is an extension of.
      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.
      Parameters:
      superTypeName - allowed object is String
      Returns:
      returned object is boolean

    • getSubEntityTypes

      public static HashSet getSubEntityTypes(String entityTypeName)

    • getSubTypes

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

    • toString

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

    • isUnset

      public boolean isUnset(String propName)
      Parameters:
      propertyName -
      Returns:
      returned object is boolean

    • isMultiValuedProperty

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