Class Entity

  • Direct Known Subclasses:
    Container, GeographicLocation, RolePlayer

    public class Entity
    extends java.lang.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 Summary

      Constructors 
      Constructor Description
      Entity()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object get​(java.lang.String propName)
      Gets the value of the requested property
      java.lang.String getChangeType()
      Gets the value of the changeType property.
      java.util.List<Entity> getChildren()
      Gets the value of the children property.
      java.util.Date getCreateTimestamp()
      Gets the value of the createTimestamp property.
      java.lang.String getDataType​(java.lang.String propName)
      Gets the Java type of the value of the provided property.
      EntitlementInfoType getEntitlementInfo()
      Gets the value of the entitlementInfo property.
      java.util.List<Group> getGroups()
      Gets the value of the groups property.
      IdentifierType getIdentifier()
      Gets the value of the identifier property.
      java.util.Date getModifyTimestamp()
      Gets the value of the modifyTimestamp property.
      Entity getParent()
      Gets the value of the parent property.
      static java.util.List getPropertyNames​(java.lang.String entityTypeName)
      Gets a list of all supported properties for this model object, Entity
      static java.util.HashSet getSubEntityTypes​(java.lang.String entityTypeName)  
      static java.util.HashSet getSubTypes()
      Gets a set of any model objects which extend this model object, Entity
      java.util.ArrayList getSuperTypes()
      Gets a list of any model objects which this model object, Entity, is an extension of.
      java.lang.String getTypeName()
      Gets the name of this model object, Entity
      java.util.List<ViewIdentifierType> getViewIdentifiers()
      Gets the value of the viewIdentifiers property.
      boolean isMandatory​(java.lang.String propName)
      Returns true if the provided property is a mandatory property; false, otherwise.
      boolean isMultiValuedProperty​(java.lang.String propName)
      Return whether the specified property is a multi-valued property and capable of holding multiple values.
      boolean isPersistentProperty​(java.lang.String propName)
      Returns true if the provided property is a persistent property; false, otherwise.
      boolean isSet​(java.lang.String propName)
      Returns true if the requested property is set; false, otherwise.
      boolean isSetChangeType()
      Returns true if the changeType property is set; false, otherwise.
      boolean isSetChildren()
      Returns true if the children property is set; false, otherwise.
      boolean isSetCreateTimestamp()
      Returns true if the createTimestamp property is set; false, otherwise.
      boolean isSetEntitlementInfo()
      Returns true if the entitlementInfo property is set; false, otherwise.
      boolean isSetGroups()
      Returns true if the groups property is set; false, otherwise.
      boolean isSetIdentifier()
      Returns true if the identifier property is set; false, otherwise.
      boolean isSetModifyTimestamp()
      Returns true if the modifyTimeStamp property is set; false, otherwise.
      boolean isSetParent()
      Returns true if the parent property is set; false, otherwise.
      boolean isSetViewIdentifiers()
      Returns true if the viewIdentifiers property is set; false, otherwise.
      boolean isSubType​(java.lang.String superTypeName)
      Returns a true if the provided model object is one that this model object extends; false, otherwise.
      boolean isUnset​(java.lang.String propName)  
      static void reInitializePropertyNames()  
      void set​(java.lang.String propName, java.lang.Object value)
      Sets the value of the provided property to the provided value.
      void setChangeType​(java.lang.String value)
      Sets the value of the changeType property.
      void setCreateTimestamp​(java.util.Date value)
      Sets the value of the createTimestamp property.
      void setEntitlementInfo​(EntitlementInfoType value)
      Sets the value of the entitlementInfo property.
      void setIdentifier​(IdentifierType value)
      Sets the value of the identifier property.
      void setModifyTimestamp​(java.util.Date value)
      Sets the value of the modifyTimestamp property.
      void setParent​(Entity value)
      Sets the value of the parent property.
      java.lang.String toString()
      Returns this model object, Entity, and its contents as a String
      void unset​(java.lang.String propName)
      Sets the value of provided property to null.
      void unsetChildren()
      Resets the children property to null.
      void unsetGroups()
      Resets the groups property to null.
      void unsetViewIdentifiers()
      Resets the viewIdentifiers property to null.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Entity

        public Entity()
    • Method Detail

      • 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 java.util.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 java.util.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 java.util.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 java.util.Date getCreateTimestamp()
        Gets the value of the createTimestamp property.
        Returns:
        possible object is Date
      • setCreateTimestamp

        public void setCreateTimestamp​(java.util.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 java.util.Date getModifyTimestamp()
        Gets the value of the modifyTimestamp property.
        Returns:
        possible object is Date
      • setModifyTimestamp

        public void setModifyTimestamp​(java.util.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
      • 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 java.lang.String getChangeType()
        Gets the value of the changeType property.
        Returns:
        possible object is String
      • setChangeType

        public void setChangeType​(java.lang.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 java.lang.Object get​(java.lang.String propName)
        Gets the value of the requested property
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is Object
      • isSet

        public boolean isSet​(java.lang.String propName)
        Returns true if the requested property is set; false, otherwise.
        Returns:
        returned object is boolean
      • set

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

        public java.lang.String getTypeName()
        Gets the name of this model object, Entity
        Returns:
        returned object is String
      • isMandatory

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

        public boolean isPersistentProperty​(java.lang.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 java.util.List getPropertyNames​(java.lang.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 java.lang.String getDataType​(java.lang.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 java.util.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​(java.lang.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 java.util.HashSet getSubEntityTypes​(java.lang.String entityTypeName)
      • getSubTypes

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

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

        public boolean isUnset​(java.lang.String propName)
        Parameters:
        propertyName -
        Returns:
        returned object is boolean
      • isMultiValuedProperty

        public boolean isMultiValuedProperty​(java.lang.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.