Package edu.vt.middleware.ldap.bean

Interface LdapResult

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addEntries​(java.util.Collection<LdapEntry> c)
      This adds a Collection of entries to this LdapResult.
      void addEntries​(java.util.Iterator<javax.naming.directory.SearchResult> i)
      This adds an Iterator of SearchResult to this LdapResult.
      void addEntries​(javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> ne)
      This adds a NamingEnumeration of SearchResult to this LdapResult.
      void addEntry​(LdapEntry e)
      This adds a new entry to this LdapResult.
      void addEntry​(javax.naming.directory.SearchResult sr)
      This adds a new entry to this LdapResult.
      void clear()
      This removes all entries from this LdapResult.
      java.util.Collection<LdapEntry> getEntries()
      This returns a Collection of LdapEntry for this LdapResult.
      LdapEntry getEntry​(java.lang.String dn)
      This returns the LdapEntry for this LdapResult with the supplied DN.
      int size()
      This returns the number of entries in this result.
      java.util.List<javax.naming.directory.SearchResult> toSearchResults()
      This returns a List of SearchResult that represent the entries in this LdapResult.

    • Method Detail

      • getEntries

        java.util.Collection<LdapEntry> getEntries()
        This returns a Collection of LdapEntry for this LdapResult.
        Returns:
        Collection

      • getEntry

        LdapEntry getEntry​(java.lang.String dn)
        This returns the LdapEntry for this LdapResult with the supplied DN.
        Parameters:
        dn - String
        Returns:
        LdapEntry

      • addEntry

        void addEntry​(LdapEntry e)
        This adds a new entry to this LdapResult.
        Parameters:
        e - LdapEntry

      • addEntry

        void addEntry​(javax.naming.directory.SearchResult sr)
       throws javax.naming.NamingException
        This adds a new entry to this LdapResult.
        Parameters:
        sr - SearchResult
        Throws:
        javax.naming.NamingException - if the search results cannot be read

      • addEntries

        void addEntries​(java.util.Collection<LdapEntry> c)
        This adds a Collection of entries to this LdapResult. The list should contain LdapEntry objects.
        Parameters:
        c - Collection

      • addEntries

        void addEntries​(javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> ne)
         throws javax.naming.NamingException
        This adds a NamingEnumeration of SearchResult to this LdapResult.
        Parameters:
        ne - NamingEnumeration
        Throws:
        javax.naming.NamingException - if the search results cannot be read

      • addEntries

        void addEntries​(java.util.Iterator<javax.naming.directory.SearchResult> i)
         throws javax.naming.NamingException
        This adds an Iterator of SearchResult to this LdapResult.
        Parameters:
        i - Iterator
        Throws:
        javax.naming.NamingException - if the search results cannot be read

      • size

        int size()
        This returns the number of entries in this result.
        Returns:
        int

      • clear

        void clear()
        This removes all entries from this LdapResult.

      • toSearchResults

        java.util.List<javax.naming.directory.SearchResult> toSearchResults()
        This returns a List of SearchResult that represent the entries in this LdapResult.
        Returns:
        List