com.dpslink.flash.util

Class NotificationContact

java.lang.Object

com.dpslink.flash.util.NotificationContact

All Implemented Interfaces:

java.io.Serializable

public class NotificationContact
extends java.lang.Object
implements java.io.Serializable

A utility class that handles Notification Framework contacts.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
NotificationContact()

Method Summary

Modifier and Type	Method and Description
static boolean	createContact(User user) Creates a new contact in the notification framework.
static boolean	deleteContact(User user) Deletes an existing contact in the notification framework.
static java.lang.String	getPushTopic(User user) Returns a user's push notification topic.
protected static boolean	setContactPrefs(User user) Sets an existing contact's notification preferences in the notification framework.
static boolean	setContactPrefs(User user, java.util.ArrayList<NotificationPref> nfprefs) Sets an existing contact's notification preferences in the notification framework.
static boolean	setContactPrefs(User user, NotificationPref nfpref) Sets an existing contact's notification preferences in the notification framework.
static boolean	updateContact(User user) Updates an existing contact in the notification framework.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

NotificationContact

public NotificationContact()

Method Detail

createContact

public static final boolean createContact(User user)

Creates a new contact in the notification framework.

Parameters:

user - (User) The user on which the contact is based.

Returns:

boolean - true if the processing was successful, otherwise false.

deleteContact

public static final boolean deleteContact(User user)

Deletes an existing contact in the notification framework.

Parameters:

user - (User) The user on which the contact is based.

Returns:

boolean - true if the delete was successful, otherwise false.

updateContact

public static final boolean updateContact(User user)

Updates an existing contact in the notification framework.

Parameters:

user - (User) The user on which the contact is based.

Returns:

boolean - true if the processing was successful, otherwise false.

getPushTopic

public static final java.lang.String getPushTopic(User user)

Returns a user's push notification topic.

Parameters:

user - (User) The user on which a contact is based.

Returns:

String - The push notification topic.

setContactPrefs

protected static final boolean setContactPrefs(User user)

Sets an existing contact's notification preferences in the notification framework. In the framework these are called route preferences and are used for free form notifications.

This method is automatically invoked by createContact() after a new contact is successfully created.

Parameters:

user - (User) The user associated with the preferences.

Returns:

boolean - true if the processing was successful, otherwise false.

setContactPrefs

public static final boolean setContactPrefs(User user,
                                            NotificationPref nfpref)

Sets an existing contact's notification preferences in the notification framework. In the framework these are called template routings and are used for template-based notifications.

Parameters:

user - (User) The user associated with the preferences.

nfpref - (NotificationPref) A notification preference object.

Returns:

boolean - true if the processing was successful, otherwise false.

setContactPrefs

public static final boolean setContactPrefs(User user,
                                            java.util.ArrayList<NotificationPref> nfprefs)

Sets an existing contact's notification preferences in the notification framework. In the framework these are called template routings and are used for template notifications.

Parameters:

user - (User) The user associated with the preferences.

nfprefs - (ArrayList) A collection of notification preference objects.

Returns:

boolean - true if the processing was successful, otherwise false.