Logo Search packages:      
Sourcecode: ldaptor version File versions

def ldaptor::interfaces::IConnectedLDAPEntry::search (   self,
  filterText = None,
  filterObject = None,
  attributes = (),
  scope = None,
  derefAliases = None,
  sizeLimit = 0,
  timeLimit = 0,
  typesOnly = 0,
  callback = None 
)


Perform an LDAP search with this object as the base.

@param filterText: LDAP search filter as a string.

@param filterObject: LDAP search filter as LDAPFilter.
Note if both filterText and filterObject are given, they
are combined with AND. If neither is given, the search is
made with a filter that matches everything.

@param attributes: List of attributes to retrieve for the
result objects. An empty list and means all.

@param scope: Whether to recurse into subtrees.

@param derefAliases: Whether to deref LDAP aliases. TODO write
better documentation.

@param sizeLimit: At most how many entries to return. 0 means
unlimited.

@param timeLimit: At most how long to use for processing the
search request. 0 means unlimited.

@param typesOnly: Whether to return attribute types only, or
also values.

@param callback: Callback function to call for each resulting
LDAPEntry. None means gather the results into a list and give
that to the Deferred returned from here.

@return: A Deferred that will complete when the search is
done. The Deferred gives None if callback was given and a list
of the search results if callback is not given or is None.

Definition at line 234 of file interfaces.py.

                           :
      """

      Perform an LDAP search with this object as the base.

      @param filterText: LDAP search filter as a string.

      @param filterObject: LDAP search filter as LDAPFilter.
      Note if both filterText and filterObject are given, they
      are combined with AND. If neither is given, the search is
      made with a filter that matches everything.

      @param attributes: List of attributes to retrieve for the
      result objects. An empty list and means all.

      @param scope: Whether to recurse into subtrees.

      @param derefAliases: Whether to deref LDAP aliases. TODO write
      better documentation.

      @param sizeLimit: At most how many entries to return. 0 means
      unlimited.

      @param timeLimit: At most how long to use for processing the
      search request. 0 means unlimited.

      @param typesOnly: Whether to return attribute types only, or
      also values.

      @param callback: Callback function to call for each resulting
      LDAPEntry. None means gather the results into a list and give
      that to the Deferred returned from here.

      @return: A Deferred that will complete when the search is
      done. The Deferred gives None if callback was given and a list
      of the search results if callback is not given or is None.

      """

    def children(self, callback=None):


Generated by  Doxygen 1.6.0   Back to index