com.unboundid.directory.sdk.ds.types

Interface AccountStatusNotification

@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface AccountStatusNotification

This class defines a data type for storing information associated with an account status notification.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage() Retrieves a message that provides additional information for this account status notification.
java.util.Map<AccountStatusNotificationProperty,java.util.List<java.lang.String>>	getNotificationProperties() Retrieves a set of properties that may provide additional information for this account status notification.
java.util.List<java.lang.String>	getNotificationProperty(AccountStatusNotificationProperty property) Retrieves the set of values for the specified account status notification property.
AccountStatusNotificationType	getNotificationType() Retrieves the notification type for this account status notification.
java.lang.String	getUserDN() Retrieves the DN of the user entry to which this notification applies.
Entry	getUserEntry() Retrieves the user entry for whom this notification applies.
java.lang.String	toString() Retrieves a string representation of this account status notification.

Method Detail

getNotificationType

AccountStatusNotificationType getNotificationType()

Retrieves the notification type for this account status notification.

Returns:

The notification type for this account status notification.

getUserDN

java.lang.String getUserDN()

Retrieves the DN of the user entry to which this notification applies.

Returns:

The DN of the user entry to which this notification applies.

getUserEntry

Entry getUserEntry()

Retrieves the user entry for whom this notification applies.

Returns:

The user entry for whom this notification applies.

getMessage

java.lang.String getMessage()

Retrieves a message that provides additional information for this account status notification.

Returns:

A message that provides additional information for this account status notification.

getNotificationProperties

java.util.Map<AccountStatusNotificationProperty,java.util.List<java.lang.String>> getNotificationProperties()

Retrieves a set of properties that may provide additional information for this account status notification.

Returns:

A set of properties that may provide additional information for this account status notification.

getNotificationProperty

java.util.List<java.lang.String> getNotificationProperty(AccountStatusNotificationProperty property)

Retrieves the set of values for the specified account status notification property.

Parameters:

property - The account status notification property for which to retrieve the associated values.

Returns:

The set of values for the specified account status notification property, or null if the specified property is not defined for this account status notification.

toString

java.lang.String toString()

Retrieves a string representation of this account status notification.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this account status notification.