com.dpslink.flash.db

Class NotificationPrefController

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.jdbc.JDBCObjectController<NotificationPref>

com.dpslink.flash.db.NotificationPrefController

All Implemented Interfaces:

java.io.Serializable

public class NotificationPrefController
extends JDBCObjectController<NotificationPref>

The controller for the NotificationPref class. Provides methods for retrieving and persisting user notification preference table records in the database.

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class com.dpslink.base.jdbc.JDBCObjectController

ivDBObjCls, ivFieldCount, ivFieldKeyAlt, ivFieldKeyPri, ivFieldResPfx, ivSyncLast, ivSyncType, ivTableName

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
NotificationPrefController() The constructor for the controller.

Method Summary

Modifier and Type	Method and Description
boolean	add(java.util.ArrayList<NotificationPref> prefs) Adds a collection of new user notification preference records to the database table.
int	add(NotificationPref obj, boolean logdup) Adds a new record to the table associated with the controller.
boolean	delete(NotificationPref obj) Deletes an existing record from the table associated with the controller.
boolean	deleteUser(java.lang.String id) Deletes all user notification preference records from the database for the given user id.
NotificationPref	get(java.lang.String id, java.lang.String type) Returns the user notification preference for the given user id and message type.
java.util.ArrayList<NotificationPref>	getUser(java.lang.String id) Returns a collection of user notification preference records for the given user id.
java.util.ArrayList<NotificationPref>	getUserDefaults(java.lang.String id, java.lang.String type) Returns the user notification preference defaults for the given user based on the given user type (shopper, sales rep, admin, etc.).
java.util.ArrayList<NotificationPref>	getUserDefaults(User user) Returns the user notification preference defaults for the given user based on the user's type (shopper, sales rep, admin, etc.).
boolean	hasInterest(java.lang.String id, java.lang.String type) Answers if a user has interest in receiving notifications for a message type.
boolean	hasUser(java.lang.String id) Answers if a given user id exists in the notification preference table.
boolean	update(NotificationPref obj) Updates an existing record in the table associated with the controller.

Methods inherited from class com.dpslink.base.jdbc.JDBCObjectController

add, add, arrayToMap, arrayToMap, countAll, delete, deleteAll, dispose, equals, getAll, getConnection, getConnectionInfo, getController, getFieldNames, getFieldNamesForKey, getFieldNamesForUpdate, getFieldNulls, getFieldNullsForKey, getFieldNullsForUpdate, getFieldsForOrderBy, getFieldsForWhere, getFieldSize, getFieldTypes, getFieldTypesForKey, getFieldTypesForUpdate, getStatementForDelete, getStatementForGet, getStatementForGetAll, getStatementForInsert, getStatementForUpdate, getStatementKey, getStatementString, getTableName, hasFieldNamesForKey, hasFieldNamesForUpdate, isDuplicate, resultSetToArray, resultSetToMap, resultSetToMap, resultSetToObject, setConnectionInfo, setPSDeleteValues, setPSExistsValues, setPSInsertValues, setPSUpdateValues, setPSValue, update, valuesToObject

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

NotificationPrefController

public NotificationPrefController()

The constructor for the controller.

Method Detail

add

public int add(NotificationPref obj,
               boolean logdup)

Adds a new record to the table associated with the controller. Overrides add in JDBCObjectController.

Overrides:

add in class JDBCObjectController<NotificationPref>

Parameters:

obj - (JDBCObject) The object for the record to be added.

logdup - (boolean) true if duplicate errors are to be logged as an exception, otherwise false if not. When duplicates are logged, the return value of 1 is never returned.

Returns:

int - 0 = success, 1 = duplicate, 2 = failure.

delete

public boolean delete(NotificationPref obj)

Deletes an existing record from the table associated with the controller.

Overrides:

delete in class JDBCObjectController<NotificationPref>

Parameters:

obj - (JDBCObject) The object for the record to be deleted.

Returns:

boolean - true if the record deleted successfully, otherwise false.

update

public boolean update(NotificationPref obj)

Updates an existing record in the table associated with the controller.

Overrides:

update in class JDBCObjectController<NotificationPref>

Parameters:

obj - (JDBCObject) The object for the record to be updated.

Returns:

boolean - true if the record updated successfully, otherwise false.

add

public boolean add(java.util.ArrayList<NotificationPref> prefs)

Adds a collection of new user notification preference records to the database table.

Parameters:

prefs - (ArrayList) A collection of notification preferences to be added.

Returns:

boolean - true if the records added successfully, otherwise false.

deleteUser

public boolean deleteUser(java.lang.String id)

Deletes all user notification preference records from the database for the given user id.

Parameters:

id - (String) The user id for the records to be deleted.

Returns:

boolean - true if the records deleted successfully, otherwise false.

get

public NotificationPref get(java.lang.String id,
                            java.lang.String type)

Returns the user notification preference for the given user id and message type.

Parameters:

id - (String) The user id for the desired record.

type - (String) The message type for the desired record.

Returns:

NotificationPref - An object initialized with values from the database.

getUser

public java.util.ArrayList<NotificationPref> getUser(java.lang.String id)

Returns a collection of user notification preference records for the given user id.

Parameters:

id - (String) The user id for the desired records.

Returns:

ArrayList - The user notification preferences for the requested user id.

getUserDefaults

public java.util.ArrayList<NotificationPref> getUserDefaults(User user)

Returns the user notification preference defaults for the given user based on the user's type (shopper, sales rep, admin, etc.).

Parameters:

user - (User) The based-on user for the defaults.

Returns:

ArrayList - The user notification preference defaults.

getUserDefaults

public java.util.ArrayList<NotificationPref> getUserDefaults(java.lang.String id,
                                                             java.lang.String type)

Returns the user notification preference defaults for the given user based on the given user type (shopper, sales rep, admin, etc.).

Parameters:

id - (String) The based-on user id for the defaults.

type - (String) The based-on user type for the defaults.

Returns:

ArrayList - The user notification preference defaults.

hasUser

public boolean hasUser(java.lang.String id)

Answers if a given user id exists in the notification preference table.

Parameters:

id - (String) The user id to check.

Returns:

boolean - true if preferences exists, otherwise false.

hasInterest

public boolean hasInterest(java.lang.String id,
                           java.lang.String type)

Answers if a user has interest in receiving notifications for a message type. A user is considered interested if they have preferences selected for email or sms or push for the message type.

Parameters:

id - (String) The id for the user to check.

type - (String) The message type to check.

Returns:

boolean - true if the user is interested, otherwise false.