com.ibm.wsspi.security.wim.model

Class SearchControl

  • Direct Known Subclasses:
    ChangeControl, HierarchyControl, LoginControl


    public class SearchControl
    extends PropertyControl

    Java class for SearchControl complex type.

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

     <complexType name="SearchControl">
     <complexContent>
     <extension base="{http://www.ibm.com/websphere/wim}PropertyControl">
     <sequence>
     <element name="searchBases" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
     </sequence>
     <attribute name="countLimit" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
     <attribute name="searchLimit" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
     <attribute name="timeLimit" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
     <attribute name="expression" type="{http://www.w3.org/2001/XMLSchema}string" />
     <attribute name="returnSubType" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </extension>
     </complexContent>
     </complexType>
     

    The SearchControl object extends the PropertyControl object.

    It is possible to provide a list of the search bases to narrow down the search by specifying the searchBases property in the SearchControl. For example, 'ou=Mahwah, o=mycompany, c=us' could be specified in 'searchBases' to only search for users in the Mahwah division in the United States.

    • countLimit: used to specify the number of results to return from the search call. If the actual number of search results is more than the countLimit, the hasMoreResults property in the SearchResponseControl will be set to true.
    • searchLimit: used to specify the maximum number of search results that may be returned by the search operation.
    • timeLimit: specifies the maximum number of milliseconds the search is allowed to take if a repository supports such a parameter.
    • expression: the search expression in XPath format.
    • Constructor Detail

      • SearchControl

        public SearchControl()
    • Method Detail

      • getSearchBases

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

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

         getSearchBases().add(newItem);
         

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

      • isSetSearchBases

        public boolean isSetSearchBases()
      • unsetSearchBases

        public void unsetSearchBases()
      • getCountLimit

        public int getCountLimit()
        Gets the value of the countLimit property.
        Returns:
        possible object is Integer
      • setCountLimit

        public void setCountLimit(int value)
        Sets the value of the countLimit property.
        Parameters:
        value - allowed object is Integer
      • isSetCountLimit

        public boolean isSetCountLimit()
      • unsetCountLimit

        public void unsetCountLimit()
      • getSearchLimit

        public int getSearchLimit()
        Gets the value of the searchLimit property.
        Returns:
        possible object is Integer
      • setSearchLimit

        public void setSearchLimit(int value)
        Sets the value of the searchLimit property.
        Parameters:
        value - allowed object is Integer
      • isSetSearchLimit

        public boolean isSetSearchLimit()
      • unsetSearchLimit

        public void unsetSearchLimit()
      • getTimeLimit

        public int getTimeLimit()
        Gets the value of the timeLimit property.
        Returns:
        possible object is Integer
      • setTimeLimit

        public void setTimeLimit(int value)
        Sets the value of the timeLimit property.
        Parameters:
        value - allowed object is Integer
      • isSetTimeLimit

        public boolean isSetTimeLimit()
      • unsetTimeLimit

        public void unsetTimeLimit()
      • getExpression

        public java.lang.String getExpression()
        Gets the value of the expression property.
        Returns:
        possible object is String
      • setExpression

        public void setExpression(java.lang.String value)
        Sets the value of the expression property.
        Parameters:
        value - allowed object is String
      • isSetExpression

        public boolean isSetExpression()
      • isReturnSubType

        public boolean isReturnSubType()
        Gets the value of the returnSubType property.
        Returns:
        possible object is Boolean
      • setReturnSubType

        public void setReturnSubType(boolean value)
        Sets the value of the returnSubType property.
        Parameters:
        value - allowed object is Boolean
      • isSetReturnSubType

        public boolean isSetReturnSubType()
      • unsetReturnSubType

        public void unsetReturnSubType()
      • 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 PropertyControl
        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 PropertyControl
        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 PropertyControl
        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 PropertyControl
        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 PropertyControl
        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 PropertyControl
        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 PropertyControl
        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 PropertyControl
        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 PropertyControl
        Returns:
        returned object is String