com.highdeal.notification

Class NotificationDescription

java.lang.Object

com.highdeal.notification.NotificationDescription

public class NotificationDescription
extends java.lang.Object

This class represents a predefined description of a notification; It specfies some keys of complementary information that must be included in the notifications.

A notification description is defined by:

• A unique identifier of the predefined description
• A name
• A pretty name (user friendly name)
• A notification severity level
• And a set of additional information keys that define the arguments of a notification message

See Also:

Notification, NotificationLevel

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String[]	getAdditionalInfoKeys() Returns the additional info descriptions of the notification.
java.lang.Object[]	getArgTypes() Returns the additional info types of this notification
java.lang.String	getName() Returns the name of the notification.
java.lang.String	getPrettyName() Returns the pretty name of the notification.
NotificationLevel	getSeverityLevel() Returns the severity level of the notification.
int	getUid() Returns the unique identifier of the notification.
int	hashCode()
boolean	isHandled() Checks if the notification is handled or not; If not the notification described by this description will not be generated by the SAP CC system.
void	isHandled(boolean isHandled) Sets if the notification is handled or not.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getArgTypes

public java.lang.Object[] getArgTypes()

Returns the additional info types of this notification

Returns:

An array of additional info types that can be empty but not null

getAdditionalInfoKeys

public java.lang.String[] getAdditionalInfoKeys()

Returns the additional info descriptions of the notification.

Returns:

An array of string that can be null

getName

public java.lang.String getName()

Returns the name of the notification.

Returns:

The name

getPrettyName

public java.lang.String getPrettyName()

Returns the pretty name of the notification.

Returns:

The pretty name

getSeverityLevel

public NotificationLevel getSeverityLevel()

Returns the severity level of the notification.

Returns:

The severity level

getUid

public int getUid()

Returns the unique identifier of the notification.

Returns:

The uid

isHandled

public void isHandled(boolean isHandled)

Sets if the notification is handled or not.

Parameters:

isHandled - true if the notification is handled, false otherwise

isHandled

public boolean isHandled()

Checks if the notification is handled or not; If not the notification described by this description will not be generated by the SAP CC system.

Returns:

true if the notification is handled, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object