Package edu.vt.middleware.ldap.bean
Interface LdapResult
-
- All Known Implementing Classes:
AbstractLdapResult
,OrderedLdapBeanFactory.OrderedLdapResult
,SortedLdapBeanFactory.SortedLdapResult
,UnorderedLdapBeanFactory.UnorderedLdapResult
public interface LdapResult
LdapResult
represents a collection of ldap entries.- Version:
- $Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $
- Author:
- Middleware Services
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addEntries(java.util.Collection<LdapEntry> c)
This adds aCollection
of entries to thisLdapResult
.void
addEntries(java.util.Iterator<javax.naming.directory.SearchResult> i)
This adds anIterator
ofSearchResult
to thisLdapResult
.void
addEntries(javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> ne)
This adds aNamingEnumeration
ofSearchResult
to thisLdapResult
.void
addEntry(LdapEntry e)
This adds a new entry to thisLdapResult
.void
addEntry(javax.naming.directory.SearchResult sr)
This adds a new entry to thisLdapResult
.void
clear()
This removes all entries from thisLdapResult
.java.util.Collection<LdapEntry>
getEntries()
This returns aCollection
ofLdapEntry
for thisLdapResult
.LdapEntry
getEntry(java.lang.String dn)
This returns theLdapEntry
for thisLdapResult
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 aList
ofSearchResult
that represent the entries in thisLdapResult
.
-
-
-
Method Detail
-
getEntries
java.util.Collection<LdapEntry> getEntries()
This returns aCollection
ofLdapEntry
for thisLdapResult
.- Returns:
Collection
-
getEntry
LdapEntry getEntry(java.lang.String dn)
This returns theLdapEntry
for thisLdapResult
with the supplied DN.- Parameters:
dn
-String
- Returns:
LdapEntry
-
addEntry
void addEntry(LdapEntry e)
This adds a new entry to thisLdapResult
.- Parameters:
e
-LdapEntry
-
addEntry
void addEntry(javax.naming.directory.SearchResult sr) throws javax.naming.NamingException
This adds a new entry to thisLdapResult
.- Parameters:
sr
-SearchResult
- Throws:
javax.naming.NamingException
- if the search results cannot be read
-
addEntries
void addEntries(java.util.Collection<LdapEntry> c)
This adds aCollection
of entries to thisLdapResult
. The list should containLdapEntry
objects.- Parameters:
c
-Collection
-
addEntries
void addEntries(javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> ne) throws javax.naming.NamingException
This adds aNamingEnumeration
ofSearchResult
to thisLdapResult
.- 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 anIterator
ofSearchResult
to thisLdapResult
.- 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 thisLdapResult
.
-
toSearchResults
java.util.List<javax.naming.directory.SearchResult> toSearchResults()
This returns aList
ofSearchResult
that represent the entries in thisLdapResult
.- Returns:
List
-
-