Package de.xima.fc.notification.mgmt

Enum NotificationAssigneeType

java.lang.Object

java.lang.Enum<NotificationAssigneeType>

de.xima.fc.notification.mgmt.NotificationAssigneeType

All Implemented Interfaces:

Serializable, Comparable<NotificationAssigneeType>

public enum NotificationAssigneeType
extends Enum<NotificationAssigneeType>
implements Serializable

The type of assignee.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMAIL	Deprecated. Not yet implemented.
USER	Assigned to a user via their user ID.

Method Summary

Modifier and Type	Method	Description
Class<? extends Serializable>	getIdClass()	The class of the assignee ID.
boolean	isChannelSupported(NotificationChannelType channelType)	Checks if the given channel type is supported by this assignee type.
boolean	isNeedsAssigneeId()	Checks if this assignee type requires an assignee ID.
static NotificationAssigneeType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NotificationAssigneeType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USER

public static final NotificationAssigneeType USER

Assigned to a user via their user ID.

EMAIL

@Deprecated
public static final NotificationAssigneeType EMAIL

Deprecated.

Not yet implemented. It is not recommended to use this type until it is fully supported.

Assigned to an email address. It is planned for this type to allow for email notifications without a user account.

Method Detail

values

public static NotificationAssigneeType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NotificationAssigneeType c : NotificationAssigneeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NotificationAssigneeType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isChannelSupported

public boolean isChannelSupported(NotificationChannelType channelType)

Checks if the given channel type is supported by this assignee type.

Parameters:

channelType - The channel type to check.

Returns:

true if the channel type is supported, false otherwise.

isNeedsAssigneeId

public boolean isNeedsAssigneeId()

Checks if this assignee type requires an assignee ID.

Returns:

true if an assignee ID is required, false otherwise.

getIdClass

public Class<? extends Serializable> getIdClass()

The class of the assignee ID. If null, no ID is required.