Package org.ldaptive.ad.control.util

Class NotificationClient.NotificationItem

java.lang.Object

org.ldaptive.ad.control.util.NotificationClient.NotificationItem

Enclosing class:

NotificationClient

public static class NotificationClient.NotificationItem
extends Object

Contains data returned when using the notification control.

Field Summary

Fields

Modifier and Type	Field	Description
private LdapEntry	searchEntry	Entry contained in this notification item.
private Exception	searchException	Exception thrown by the search operation.
private Result	searchResult	Result contained in this notification item.

Constructor Summary

Constructors

Constructor	Description
NotificationItem(Exception exception)	Creates a new notification item.
NotificationItem(LdapEntry entry)	Creates a new notification item.
NotificationItem(Result result)	Creates a new notification item.

Method Summary

Modifier and Type	Method	Description
LdapEntry	getEntry()	Returns the search entry contained in this item or null if this item does not contain a search entry.
Exception	getException()	Returns the exception contained in this item or null if this item does not contain an exception.
Result	getResult()	Returns the response contained in this item or null if this item does not contain a response.
boolean	isEntry()	Returns whether this item represents a search entry.
boolean	isException()	Returns whether this item represents an exception.
boolean	isResult()	Returns whether this item represents a response.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

searchEntry

private final LdapEntry searchEntry

Entry contained in this notification item.

searchResult

private final Result searchResult

Result contained in this notification item.

searchException

private final Exception searchException

Exception thrown by the search operation.

Constructor Detail

NotificationItem

public NotificationItem(LdapEntry entry)

Creates a new notification item.

Parameters:

entry - that represents this item

NotificationItem

public NotificationItem(Result result)

Creates a new notification item.

Parameters:

result - that represents this item

NotificationItem

public NotificationItem(Exception exception)

Creates a new notification item.

Parameters:

exception - that represents this item

Method Detail

isEntry

public boolean isEntry()

Returns whether this item represents a search entry.

Returns:

whether this item represents a search entry

getEntry

public LdapEntry getEntry()

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

Returns:

search entry

isResult

public boolean isResult()

Returns whether this item represents a response.

Returns:

whether this item represents a response

getResult

public Result getResult()

Returns the response contained in this item or null if this item does not contain a response.

Returns:

response

isException

public boolean isException()

Returns whether this item represents an exception.

Returns:

whether this item represents an exception

getException

public Exception getException()

Returns the exception contained in this item or null if this item does not contain an exception.

Returns:

exception

toString

public String toString()

Overrides:

toString in class Object