org.ldaptive.provider

Class SearchItem

java.lang.Object

org.ldaptive.provider.SearchItem

public class SearchItem
extends java.lang.Object

Contains the data returned from a search request.

Field Summary

Fields

Modifier and Type	Field and Description
private IntermediateResponse	intermediateResponse intermediate response.
private SearchEntry	searchEntry search entry.
private SearchReference	searchReference search reference.

Constructor Summary

Constructors

Constructor and Description
SearchItem(IntermediateResponse ir) Creates a new search item.
SearchItem(SearchEntry se) Creates a new search item.
SearchItem(SearchReference sr) Creates a new search item.

Method Summary

Modifier and Type	Method and Description
IntermediateResponse	getIntermediateResponse() Returns the intermediate response in this search item or null if this search item does not contain an intermediate response.
SearchEntry	getSearchEntry() Returns the search entry in this search item or null if this search item does not contain a search entry.
SearchReference	getSearchReference() Returns the search reference in this search item or null if this search item does not contain a search reference.
boolean	isIntermediateResponse() Returns whether this search item contains an intermediate response.
boolean	isSearchEntry() Returns whether this search item contains a search entry.
boolean	isSearchReference() Returns whether this search item contains a search reference.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

searchEntry

private final SearchEntry searchEntry

search entry.

searchReference

private final SearchReference searchReference

search reference.

intermediateResponse

private final IntermediateResponse intermediateResponse

intermediate response.

Constructor Detail

SearchItem

public SearchItem(SearchEntry se)

Creates a new search item.

Parameters:

se - ldap entry

SearchItem

public SearchItem(SearchReference sr)

Creates a new search item.

Parameters:

sr - searchReference

SearchItem

public SearchItem(IntermediateResponse ir)

Creates a new search item.

Parameters:

ir - intermediate response

Method Detail

isSearchEntry

public boolean isSearchEntry()

Returns whether this search item contains a search entry.

Returns:

whether this search item contains a search entry

getSearchEntry

public SearchEntry getSearchEntry()

Returns the search entry in this search item or null if this search item does not contain a search entry.

Returns:

search entry

isSearchReference

public boolean isSearchReference()

Returns whether this search item contains a search reference.

Returns:

whether this search item contains a search reference

getSearchReference

public SearchReference getSearchReference()

Returns the search reference in this search item or null if this search item does not contain a search reference.

Returns:

searchReference

isIntermediateResponse

public boolean isIntermediateResponse()

Returns whether this search item contains an intermediate response.

Returns:

whether this search item contains an intermediate response

getIntermediateResponse

public IntermediateResponse getIntermediateResponse()

Returns the intermediate response in this search item or null if this search item does not contain an intermediate response.

Returns:

intermediate response

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object