com.ihr.xbrl.notifications

Class Notification

java.lang.Object

com.ihr.xbrl.notifications.Notification

public class Notification
extends java.lang.Object

The Class Notification.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.NotificationStorage The Enum NotificationStorage.
static class	Notification.NotificationType The Enum NotificationType.

Constructor Summary

Constructors

Constructor and Description
Notification(Notification.NotificationType type, java.lang.String message, java.lang.String link) Create a volatile notification with a notification type and message.
Notification(Notification.NotificationType type, java.lang.String message, java.lang.String link, java.lang.String id) Create a permanent notification with a notification type and message.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Equals.
java.lang.String	getId() Permanent notifications has an UUID set in the server.
java.lang.String	getLink() If this notification has a link the method returns the URI otherwise this method returns null.
java.lang.String	getMessage() Gets the message.
java.lang.String	getProcessedMessage() Gets the processed message.
Notification.NotificationStorage	getStorage() Gets the storage.
Notification.NotificationType	getType() Gets the type.
int	hashCode() Hash code.

Methods inherited from class java.lang.Object

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

Constructor Detail

Notification

public Notification(Notification.NotificationType type,
                    java.lang.String message,
                    java.lang.String link)

Create a volatile notification with a notification type and message. This notification will not be stored in the database

Parameters:

type - the type

message - the message

link - optional link

Notification

public Notification(Notification.NotificationType type,
                    java.lang.String message,
                    java.lang.String link,
                    java.lang.String id)

Create a permanent notification with a notification type and message.

Parameters:

type - the type

message - the message

link - optional link

id - the complete urn:uuid:UUID value for this notification

Method Detail

getMessage

public java.lang.String getMessage()

Gets the message.

Returns:

the message

getProcessedMessage

public java.lang.String getProcessedMessage()

Gets the processed message.

Returns:

If the notification contains a link this method returns a string in HTML to be used to represent the message. If the notification contains no link, this method returns the message

getType

public Notification.NotificationType getType()

Gets the type.

Returns:

the type

getStorage

public Notification.NotificationStorage getStorage()

Gets the storage.

Returns:

the storage

hashCode

public int hashCode()

Hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

the int

equals

public boolean equals(java.lang.Object obj)

Equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the obj

Returns:

true, if successful

getId

public java.lang.String getId()

Permanent notifications has an UUID set in the server.

Returns:

the id

getLink

public java.lang.String getLink()

If this notification has a link the method returns the URI otherwise this method returns null.

Returns:

the link or null