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.

Constructor Summary

NotificationClient.NotificationItem(AsyncRequest request)
Creates a new notification item.

NotificationClient.NotificationItem(Exception exception)
Creates a new notification item.

NotificationClient.NotificationItem(Response response)
Creates a new notification item.

NotificationClient.NotificationItem(SearchEntry entry)
Creates a new notification item.

Method Summary

AsyncRequest	getAsyncRequest() Returns the async request contained in this item or null if this item does not contain an async request.
SearchEntry	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.
Response	getResponse() Returns the response contained in this item or null if this item does not contain a response.
boolean	isAsyncRequest() Returns whether this item represents an async request.
boolean	isEntry() Returns whether this item represents a search entry.
boolean	isException() Returns whether this item represents an exception.
boolean	isResponse() Returns whether this item represents a response.
boolean	isSearchEntry() Deprecated. use isEntry() instead
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationClient.NotificationItem

public NotificationClient.NotificationItem(AsyncRequest request)

Creates a new notification item.

Parameters:

request - that represents this item

NotificationClient.NotificationItem

public NotificationClient.NotificationItem(SearchEntry entry)

Creates a new notification item.

Parameters:

entry - that represents this item

NotificationClient.NotificationItem

public NotificationClient.NotificationItem(Response response)

Creates a new notification item.

Parameters:

response - that represents this item

NotificationClient.NotificationItem

public NotificationClient.NotificationItem(Exception exception)

Creates a new notification item.

Parameters:

exception - that represents this item

Method Detail

isAsyncRequest

public boolean isAsyncRequest()

Returns whether this item represents an async request.

Returns:

whether this item represents an async request

getAsyncRequest

public AsyncRequest getAsyncRequest()

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

Returns:

async request

isEntry

public boolean isEntry()

Returns whether this item represents a search entry.

Returns:

whether this item represents a search entry

isSearchEntry

@Deprecated
public boolean isSearchEntry()

Deprecated. use isEntry() instead

Returns whether this item represents a search entry.

Returns:

whether this item represents a search entry

getEntry

public SearchEntry getEntry()

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

Returns:

search entry

isResponse

public boolean isResponse()

Returns whether this item represents a response.

Returns:

whether this item represents a response

getResponse

public Response getResponse()

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