com.ontimize.util.notice

Interface INoticeSystem

All Superinterfaces:

Remote

All Known Implementing Classes:

DelegationPermissionReferenceLocator, DelegationSecurePermissionSecureReferenceLocator, PermissionReferenceLocator, PermissionSecureReferenceLocator, ReferenceLocator, SecureReferenceLocator

public interface INoticeSystem
extends Remote

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERNAL_NOTICE_PERIOD
static String	MAIL_CONF_PROPERTIES
static String	NOTICE_CONTENT Notice entity column name which specifies the notice content
static String	NOTICE_CREATE_DATE Notice entity column name that specifies the notice generation date
static String	NOTICE_DELETE_RECEIVE_NOTICE This column sets the received notice as deleted
static String	NOTICE_DELETE_SEND_NOTICE This column sets the sent notices as deleted
static String	NOTICE_DESTINY_KEY Key name of the notice destiny entity.
static String	NOTICE_ENTITY_DESTINY_TABLE_DB
static String	NOTICE_ENTITY_TABLE_DB
static String	NOTICE_FORCE_READ Notice entity column name which indicates if this is a mandatory read notice
static String	NOTICE_FROM_PARAMETER Column name of the notices entity where is stored the name of the user that generates the notice
static String	NOTICE_KEY Notice entity key
static String	NOTICE_MAILTO_PARAMETER Destiny entity column name which the mail addresses the notices are send to are stored in
static String	NOTICE_MESSAGE_COLUMN_NAME
static String	NOTICE_MESSAGE_TYPE_COLUMN_NAME
static String	NOTICE_OTHER_COLUMNS
static String	NOTICE_READ Destiny entity column name which indicates if this notice has been read (this column is only used for internal notices)
static String	NOTICE_READ_DATE Destiny entity column name which indicates the notice read date
static String	NOTICE_RESPONSE_REQUEST Notices entity column name which indicates if this notice requests confirmation (0 = without response request)
static String	NOTICE_SEND Destiny entity column name which indicates if this notice has been sent, when notice is internal notice this columns indicates if destiny user has queried the notice.
static String	NOTICE_SEND_DATE Destiny entity column name which specifies the notice sent date
static String	NOTICE_SEND_MAIL Destiny entity column name which indicates if this notice must be send in a email (0 = internal notice, 1= email notice)
static String	NOTICE_SUBJECT Notice entity column name which specifies se notice subject
static String	NOTICE_SYSTEM Parameter that must exists in the reference locator (local and remote) to allow that all notices threads start.
static String	NOTICE_TO_PARAMETER Column name of the destiny entity where user name is stored
static String	PROP_NOTICE_CLASS_MAIL
static String	PROP_NOTICE_CONFIG_DEFAULT_TEMPLATE
static String	PROP_NOTICE_CONFIG_MAIL
static String	PROP_NOTICE_CONFIG_REQUEST_TEMPLATE
static String	PROP_NOTICE_CONFIG_TEMPLATES
static String	PROP_NOTICE_ENTITY_DESTINY_NAME
static String	PROP_NOTICE_ENTITY_NAME
static String	SEND_MAIL_PERIOD

Method Summary

Methods

Modifier and Type	Method and Description
void	checkNoticeSent(int sessionId, Object noticeKey) This method sets a notices as sent
EntityResult	getInternalNotices(int sessionId, boolean unsend, boolean unread, boolean deleted) Method to get all notices for the specified user.
String	getNoticeEntityDestinyName() Get the name of the notice destiny entity
String	getNoticeEntityName() Get the name of the notice entity
Vector	getNoticeTypes() Get the identifies for all notices types in the application
EntityResult	getSentNotices(int sessionId, Boolean deleted) Method to query all notices sent by the specified user
Object	getUserId(int sessionId) Get the identification of the user that must be stored in the notice system to identify this application user.
void	removeReceivedNotices(int sessionId, Vector idNotices) This method removes the specified received notices for the user with this session identifier.
void	removeSentNotices(int sessionId, Vector idNotices) This method sets the specified notices as deleted
void	sendNotice(Hashtable messageValues, int sessionId, boolean request) Method used to send notices.
void	setNoticesRead(int sessionId, Vector idNotices) Method to set some notices as read

Field Detail

NOTICE_SYSTEM

static final String NOTICE_SYSTEM

Parameter that must exists in the reference locator (local and remote) to allow that all notices threads start.

See Also:

Constant Field Values

PROP_NOTICE_ENTITY_NAME

static final String PROP_NOTICE_ENTITY_NAME

See Also:

Constant Field Values

PROP_NOTICE_ENTITY_DESTINY_NAME

static final String PROP_NOTICE_ENTITY_DESTINY_NAME

See Also:

Constant Field Values

PROP_NOTICE_CONFIG_MAIL

static final String PROP_NOTICE_CONFIG_MAIL

See Also:

Constant Field Values

PROP_NOTICE_CLASS_MAIL

static final String PROP_NOTICE_CLASS_MAIL

See Also:

Constant Field Values

PROP_NOTICE_CONFIG_TEMPLATES

static final String PROP_NOTICE_CONFIG_TEMPLATES

See Also:

Constant Field Values

PROP_NOTICE_CONFIG_DEFAULT_TEMPLATE

static final String PROP_NOTICE_CONFIG_DEFAULT_TEMPLATE

See Also:

Constant Field Values

PROP_NOTICE_CONFIG_REQUEST_TEMPLATE

static final String PROP_NOTICE_CONFIG_REQUEST_TEMPLATE

See Also:

Constant Field Values

MAIL_CONF_PROPERTIES

static final String MAIL_CONF_PROPERTIES

See Also:

Constant Field Values

INTERNAL_NOTICE_PERIOD

static final String INTERNAL_NOTICE_PERIOD

See Also:

Constant Field Values

SEND_MAIL_PERIOD

static final String SEND_MAIL_PERIOD

See Also:

Constant Field Values

NOTICE_ENTITY_TABLE_DB

static final String NOTICE_ENTITY_TABLE_DB

See Also:

Constant Field Values

NOTICE_ENTITY_DESTINY_TABLE_DB

static final String NOTICE_ENTITY_DESTINY_TABLE_DB

See Also:

Constant Field Values

NOTICE_MESSAGE_TYPE_COLUMN_NAME

static final String NOTICE_MESSAGE_TYPE_COLUMN_NAME

See Also:

Constant Field Values

NOTICE_OTHER_COLUMNS

static final String NOTICE_OTHER_COLUMNS

See Also:

Constant Field Values

NOTICE_KEY

static final String NOTICE_KEY

Notice entity key

See Also:

Constant Field Values

NOTICE_DESTINY_KEY

static final String NOTICE_DESTINY_KEY

Key name of the notice destiny entity.

See Also:

Constant Field Values

NOTICE_TO_PARAMETER

static final String NOTICE_TO_PARAMETER

Column name of the destiny entity where user name is stored

See Also:

Constant Field Values

NOTICE_FROM_PARAMETER

static final String NOTICE_FROM_PARAMETER

Column name of the notices entity where is stored the name of the user that generates the notice

See Also:

Constant Field Values

NOTICE_MAILTO_PARAMETER

static final String NOTICE_MAILTO_PARAMETER

Destiny entity column name which the mail addresses the notices are send to are stored in

See Also:

Constant Field Values

NOTICE_RESPONSE_REQUEST

static final String NOTICE_RESPONSE_REQUEST

Notices entity column name which indicates if this notice requests confirmation (0 = without response request)

See Also:

Constant Field Values

NOTICE_SEND_MAIL

static final String NOTICE_SEND_MAIL

Destiny entity column name which indicates if this notice must be send in a email (0 = internal notice, 1= email notice)

See Also:

Constant Field Values

NOTICE_READ

static final String NOTICE_READ

Destiny entity column name which indicates if this notice has been read (this column is only used for internal notices)

See Also:

Constant Field Values

NOTICE_READ_DATE

static final String NOTICE_READ_DATE

Destiny entity column name which indicates the notice read date

See Also:

Constant Field Values

NOTICE_SEND

static final String NOTICE_SEND

Destiny entity column name which indicates if this notice has been sent, when notice is internal notice this columns indicates if destiny user has queried the notice.

See Also:

Constant Field Values

NOTICE_CREATE_DATE

static final String NOTICE_CREATE_DATE

Notice entity column name that specifies the notice generation date

See Also:

Constant Field Values

NOTICE_SEND_DATE

static final String NOTICE_SEND_DATE

Destiny entity column name which specifies the notice sent date

See Also:

Constant Field Values

NOTICE_SUBJECT

static final String NOTICE_SUBJECT

Notice entity column name which specifies se notice subject

See Also:

Constant Field Values

NOTICE_CONTENT

static final String NOTICE_CONTENT

Notice entity column name which specifies the notice content

See Also:

Constant Field Values

NOTICE_FORCE_READ

static final String NOTICE_FORCE_READ

Notice entity column name which indicates if this is a mandatory read notice

See Also:

Constant Field Values

NOTICE_DELETE_SEND_NOTICE

static final String NOTICE_DELETE_SEND_NOTICE

This column sets the sent notices as deleted

See Also:

Constant Field Values

NOTICE_DELETE_RECEIVE_NOTICE

static final String NOTICE_DELETE_RECEIVE_NOTICE

This column sets the received notice as deleted

See Also:

Constant Field Values

NOTICE_MESSAGE_COLUMN_NAME

static final String NOTICE_MESSAGE_COLUMN_NAME

See Also:

Constant Field Values

Method Detail

sendNotice

void sendNotice(Hashtable messageValues,
              int sessionId,
              boolean request)
                throws Exception

Method used to send notices. This method insert the notice in the notice entity and insert all destinies in the destiny notice entity

Parameters:

messageValues -

sessionId -

request - If this is true, the notices is a request notice. In this case the correct template must be selected

Throws:

Exception

getInternalNotices

EntityResult getInternalNotices(int sessionId,
                              boolean unsend,
                              boolean unread,
                              boolean deleted)
                                throws Exception

Method to get all notices for the specified user.
In this method is possible specified if the user wants all messages or only unread ones

Parameters:

sessionId - User session identifier

unsend - When this is true only return the unsend notices

unread - When this is true ontly return the unread notices

Returns:

Throws:

Exception

setNoticesRead

void setNoticesRead(int sessionId,
                  Vector idNotices)
                    throws Exception

Method to set some notices as read

Parameters:

sessionId - User session identifier

idNotices - Array with the notice keys

Throws:

Exception

getSentNotices

EntityResult getSentNotices(int sessionId,
                          Boolean deleted)
                            throws Exception

Method to query all notices sent by the specified user

Parameters:

sessionId - User session identifier

deleted - deleted = true only query the deleted notices
deleted = false only query not deleted notices
deleted = null query all sent notices

Returns:

Throws:

Exception

checkNoticeSent

void checkNoticeSent(int sessionId,
                   Object noticeKey)
                     throws Exception

This method sets a notices as sent

Parameters:

sessionId - User session identifier

noticeKey - Notice key.

Throws:

Exception

removeSentNotices

void removeSentNotices(int sessionId,
                     Vector idNotices)
                       throws Exception

This method sets the specified notices as deleted

Parameters:

sessionId - User session identifier

idNotices - Keys of the notices to remove

Throws:

Exception

removeReceivedNotices

void removeReceivedNotices(int sessionId,
                         Vector idNotices)
                           throws Exception

This method removes the specified received notices for the user with this session identifier.

Parameters:

sessionId - User session identifier

idNotices - Notice keys

Throws:

Exception

getNoticeTypes

Vector getNoticeTypes()
                      throws Exception

Get the identifies for all notices types in the application

Returns:

Throws:

Exception

getNoticeEntityName

String getNoticeEntityName()
                           throws Exception

Get the name of the notice entity

Returns:

Throws:

Exception

getNoticeEntityDestinyName

String getNoticeEntityDestinyName()
                                  throws Exception

Get the name of the notice destiny entity

Returns:

Throws:

Exception

getUserId

Object getUserId(int sessionId)
                 throws Exception

Get the identification of the user that must be stored in the notice system to identify this application user. In this way the identification of a user can be not only a string.

Parameters:

sessionId - User session identifier

Returns:

Throws:

Exception