Class SearchResponse
- java.lang.Object
-
- org.apache.directory.api.ldap.model.message.AbstractMessage
-
- org.apache.directory.api.ldap.model.message.AbstractResponse
-
- org.apache.directory.api.dsmlv2.response.SearchResponse
-
public class SearchResponse extends AbstractResponse
This class represents the DSML Search Response- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description SearchResponse()
Creates a new instance of SearchResponse.SearchResponse(int messageId)
Creates a new instance of SearchResponse.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
addSearchResultEntry(SearchResultEntryDsml searchResultEntry)
Adds a Search Result Entryboolean
addSearchResultReference(SearchResultReferenceDsml searchResultReference)
Adds a Search Result ReferenceSearchResultEntryDsml
getCurrentSearchResultEntry()
Gets the Current Search Result EntrySearchResultReferenceDsml
getCurrentSearchResultReference()
Gets the current Search Result ReferenceSearchResultDoneDsml
getSearchResultDone()
Gets the Search Result EntryList<SearchResultEntryDsml>
getSearchResultEntryList()
Gets the Search Result Entry ListList<SearchResultReferenceDsml>
getSearchResultReferenceList()
Gets the Search Result Reference ListMessageTypeEnum
getType()
Gets the LDAP message type code associated with this Message.boolean
removeSearchResultEntry(SearchResultEntryDsml searchResultEntry)
Removes a Search Result Entryboolean
removeSearchResultReference(SearchResultReferenceDsml searchResultReference)
Removes a Search Result Referencevoid
setSearchResultDone(SearchResultDoneDsml searchResultDone)
Sets the Search Result Entry-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage
addAllControls, addControl, equals, get, getControl, getControls, getMessageId, hasControl, hashCode, put, removeControl, setMessageId, toString
-
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
addAllControls, addControl, get, getControl, getControls, getMessageId, hasControl, put, removeControl, setMessageId
-
-
-
-
Constructor Detail
-
SearchResponse
public SearchResponse()
Creates a new instance of SearchResponse.
-
SearchResponse
public SearchResponse(int messageId)
Creates a new instance of SearchResponse.- Parameters:
messageId
- the response eliciting this Request
-
-
Method Detail
-
addSearchResultEntry
public boolean addSearchResultEntry(SearchResultEntryDsml searchResultEntry)
Adds a Search Result Entry- Parameters:
searchResultEntry
- the Search Result Entry to add- Returns:
- true (as per the general contract of the Collection.add method)
-
removeSearchResultEntry
public boolean removeSearchResultEntry(SearchResultEntryDsml searchResultEntry)
Removes a Search Result Entry- Parameters:
searchResultEntry
- the Search Result Entry to remove- Returns:
- true (as per the general contract of the Collection.remove method)
-
getCurrentSearchResultEntry
public SearchResultEntryDsml getCurrentSearchResultEntry()
Gets the Current Search Result Entry- Returns:
- the current Searche Result Entry
-
getSearchResultEntryList
public List<SearchResultEntryDsml> getSearchResultEntryList()
Gets the Search Result Entry List- Returns:
- the Search Result Entry List
-
addSearchResultReference
public boolean addSearchResultReference(SearchResultReferenceDsml searchResultReference)
Adds a Search Result Reference- Parameters:
searchResultReference
- the Search Result Reference to add- Returns:
- true (as per the general contract of the Collection.add method)
-
removeSearchResultReference
public boolean removeSearchResultReference(SearchResultReferenceDsml searchResultReference)
Removes a Search Result Reference- Parameters:
searchResultReference
- the Search Result Reference to remove- Returns:
- true (as per the general contract of the Collection.remove method)
-
getCurrentSearchResultReference
public SearchResultReferenceDsml getCurrentSearchResultReference()
Gets the current Search Result Reference- Returns:
- the current Search Result Reference
-
getSearchResultReferenceList
public List<SearchResultReferenceDsml> getSearchResultReferenceList()
Gets the Search Result Reference List- Returns:
- the Search Result Reference List
-
getSearchResultDone
public SearchResultDoneDsml getSearchResultDone()
Gets the Search Result Entry- Returns:
- the Search Result Entry
-
setSearchResultDone
public void setSearchResultDone(SearchResultDoneDsml searchResultDone)
Sets the Search Result Entry- Parameters:
searchResultDone
- the Search Result Entry to set
-
getType
public MessageTypeEnum getType()
Gets the LDAP message type code associated with this Message. Each request and response type has a unique message type code defined by the protocol in RFC 2251.- Specified by:
getType
in interfaceMessage
- Overrides:
getType
in classAbstractMessage
- Returns:
- the message type code.
-
-