Class PropertyControl

  • Direct Known Subclasses:
    SearchControl

    public class PropertyControl
    extends Control

    Java class for PropertyControl complex type.

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

     <complexType name="PropertyControl">
     <complexContent>
     <extension base="{http://www.ibm.com/websphere/wim}Control">
     <sequence>
     <element name="properties" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
     <element name="contextProperties" maxOccurs="unbounded" minOccurs="0">
     <complexType>
     <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>string">
     <attribute ref="{http://www.w3.org/XML/1998/namespace}lang"/>
     </extension>
     </simpleContent>
     </complexType>
     </element>
     </sequence>
     </extension>
     </complexContent>
     </complexType>
     

    The PropertyControl object extends the Control object.

    PropertyControl is used in the input Root object of the get() API to specify the properties of the entity to be returned.

    • properties: a list of the properties to return from the entities which match the search criteria. For example, properties may include the 'sn' and 'givenName' attributes of the users who are managers.
    • contextProperties: used for adding names of the contexted properties and the meta data, for e.g. the description property with meta data 'lang=FR'.

    If the property 'properties' contains a wildcard value '*', all supported properties of the entity will be returned

    • Constructor Summary

      Constructors 
      Constructor Description
      PropertyControl()  
    • 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.util.List<PropertyControl.ContextProperties> getContextProperties()
      Gets the value of the contextProperties property.
      java.lang.String getDataType​(java.lang.String propName)
      Gets the Java type of the value of the provided property.
      java.util.List<java.lang.String> getProperties()
      Gets the value of the properties property.
      static java.util.List getPropertyNames​(java.lang.String entityTypeName)  
      static java.util.HashSet getSubTypes()  
      java.util.ArrayList getSuperTypes()
      Gets a list of any model objects which this model object, Control, is an extension of.
      java.lang.String getTypeName()
      Gets the name of this model object, Control
      boolean isSet​(java.lang.String propName)
      Returns true if the requested property is set; false, otherwise.
      boolean isSetContextProperties()  
      boolean isSetProperties()  
      boolean isSubType​(java.lang.String superTypeName)
      Returns a true if the provided model object is one that this model object extends; false, otherwise.
      void set​(java.lang.String propName, java.lang.Object value)
      Sets the value of the provided property to the provided value.
      java.lang.String toString()
      Returns this model object, Control, and its contents as a String
      void unset​(java.lang.String propName)
      Sets the value of provided property to null.
      void unsetContextProperties()  
      void unsetProperties()  
      • Methods inherited from class java.lang.Object

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

      • PropertyControl

        public PropertyControl()
    • Method Detail

      • getProperties

        public java.util.List<java.lang.String> getProperties()
        Gets the value of the properties 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 properties property.

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

         getProperties().add(newItem);
         

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

      • isSetProperties

        public boolean isSetProperties()
      • unsetProperties

        public void unsetProperties()
      • getContextProperties

        public java.util.List<PropertyControl.ContextProperties> getContextProperties()
        Gets the value of the contextProperties 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 contextProperties property.

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

         getContextProperties().add(newItem);
         

        Objects of the following type(s) are allowed in the list PropertyControl.ContextProperties

      • isSetContextProperties

        public boolean isSetContextProperties()
      • unsetContextProperties

        public void unsetContextProperties()
      • get

        public java.lang.Object get​(java.lang.String propName)
        Description copied from class: Control
        Gets the value of the requested property
        Overrides:
        get in class Control
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is Object
      • isSet

        public boolean isSet​(java.lang.String propName)
        Description copied from class: Control
        Returns true if the requested property is set; false, otherwise.
        Overrides:
        isSet in class Control
        Returns:
        returned object is boolean
      • set

        public void set​(java.lang.String propName,
                        java.lang.Object value)
        Description copied from class: Control
        Sets the value of the provided property to the provided value.
        Overrides:
        set in class Control
        Parameters:
        propName - allowed object is String
        value - allowed object is Object
      • unset

        public void unset​(java.lang.String propName)
        Description copied from class: Control
        Sets the value of provided property to null.
        Overrides:
        unset in class Control
        Parameters:
        propName - allowed object is String
      • getTypeName

        public java.lang.String getTypeName()
        Description copied from class: Control
        Gets the name of this model object, Control
        Overrides:
        getTypeName in class Control
        Returns:
        returned object is String
      • getPropertyNames

        public static java.util.List getPropertyNames​(java.lang.String entityTypeName)
      • getDataType

        public java.lang.String getDataType​(java.lang.String propName)
        Description copied from class: Control
        Gets the Java type of the value of the provided property. For example: String, List
        Overrides:
        getDataType in class Control
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is String
      • getSuperTypes

        public java.util.ArrayList getSuperTypes()
        Description copied from class: Control
        Gets a list of any model objects which this model object, Control, is an extension of.
        Overrides:
        getSuperTypes in class Control
        Returns:
        returned object is ArrayList
      • isSubType

        public boolean isSubType​(java.lang.String superTypeName)
        Description copied from class: Control
        Returns a true if the provided model object is one that this model object extends; false, otherwise.
        Overrides:
        isSubType in class Control
        Parameters:
        superTypeName - allowed object is String
        Returns:
        returned object is boolean
      • getSubTypes

        public static java.util.HashSet getSubTypes()
      • toString

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