Class SearchResponseControl

  • Direct Known Subclasses:
    ChangeResponseControl

    public class SearchResponseControl
    extends Control

    Java class for SearchResponseControl complex type.

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

     <complexType name="SearchResponseControl">
     <complexContent>
     <extension base="{http://www.ibm.com/websphere/wim}Control">
     <attribute name="hasMoreResults" type="{http://www.w3.org/2001/XMLSchema}boolean" />
     </extension>
     </complexContent>
     </complexType>
     

    The SearchResponseControl object extends the Control object, and contains the hasMoreResultsproperty.

    A SearchResponseControl object will only be returned from a search API call if the countLimit property in the SearchControl object is set to a value greater than 0.

    • hasMoreResults: will be set to true if the actual number of results from the search is greater than the value of the countLimit property in the SearchControl object.
    • 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 getDataType​(java.lang.String propName)
      Gets the Java type of the value of the provided 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 isHasMoreResults()
      Gets the value of the hasMoreResults property.
      boolean isSet​(java.lang.String propName)
      Returns true if the requested property is set; false, otherwise.
      boolean isSetHasMoreResults()  
      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.
      void setHasMoreResults​(boolean value)
      Sets the value of the hasMoreResults property.
      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 unsetHasMoreResults()  
      • Methods inherited from class java.lang.Object

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

      • SearchResponseControl

        public SearchResponseControl()
    • Method Detail

      • isHasMoreResults

        public boolean isHasMoreResults()
        Gets the value of the hasMoreResults property.
        Returns:
        possible object is Boolean
      • setHasMoreResults

        public void setHasMoreResults​(boolean value)
        Sets the value of the hasMoreResults property.
        Parameters:
        value - allowed object is Boolean
      • isSetHasMoreResults

        public boolean isSetHasMoreResults()
      • unsetHasMoreResults

        public void unsetHasMoreResults()
      • 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