com.accela.aa.emse.dom

Class CommunicationScript

java.lang.Object

com.accela.aa.emse.dom.service.BaseAAScript

com.accela.aa.emse.dom.CommunicationScript

All Implemented Interfaces:

com.accela.aa.emse.dom.service.CommunicationScriptService, com.accela.aa.emse.dom.service.ScriptAble

public class CommunicationScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements com.accela.aa.emse.dom.service.CommunicationScriptService

 
  Accela Automation
  File: CommunicationScript.java
 
  Accela, Inc.
  Copyright (C): 2012-2013
 
  Description:
  The implementation for the communication script, which will be used by the scripters.
 
  Notes:
        $Id: CommunicationScript.java 72642 2009-01-01 20:01:57Z ..\tom.liang $ 
 
  Revision History
  <Date>,                 <Who>,                    <What>
  Dec 31, 2012          tom.liang               Initial.
  
 

Constructor Summary

Constructors

Constructor and Description
CommunicationScript() CommunicationScript Constructor.
CommunicationScript(java.lang.String serviceProviderCode, java.lang.String auditID) CommunicationScript Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	associateEnities(java.lang.String communicationId, java.lang.String entityId, java.lang.String entityType) associate entities.
ScriptResult	createTask(com.accela.aa.notification.model.CalendarTaskModel taskModel) create external outlook task
ScriptResult	deleteTask(com.accela.aa.notification.model.CalendarTaskModel taskModel) delete external outlook task
ScriptResult	getContactList(java.lang.String[][] params, java.lang.String messageType) Get contanct list.
ScriptResult	getEmailMessageScriptModel() Return email message object.
ScriptResult	getI18nVariables() Get I18n variables.
ScriptResult	getNewTaskModel() Returns a new TaskModel object.
ScriptResult	getNotificationTemplate(java.lang.String templateName) Get notification template.
ScriptResult	getNotificationTemplateModel() Return notification template object.
ScriptResult	getSMSMessageScriptModel() Return sms message object.
ScriptResult	resendFailedMessages(java.lang.String[] types) Resend failed messages.
ScriptResult	sendMessage(EmailMessageScriptModel messageScriptModel) Send message by message model.
ScriptResult	sendMessage(SMSMessageScriptModel messageScriptModel) Send message.
ScriptResult	sendMessages(java.lang.String templateName, java.util.Hashtable<java.lang.String,java.lang.String> variables, java.lang.String triggerEvent) Send message by notification template.
ScriptResult	sendMessages(java.lang.String templateName, java.util.Hashtable<java.lang.String,java.lang.String> variables, java.lang.String triggerEvent, java.lang.String[][] relatedEntities) Send messages.
ScriptResult	sendMessagesWithI18NParameters(java.lang.String templateName, java.util.Hashtable<java.lang.String,java.util.Hashtable<java.lang.String,java.lang.String>> i18nVariables, java.lang.String triggerEvent) Send message with I18N parameters
ScriptResult	updateTask(com.accela.aa.notification.model.CalendarTaskModel taskModel) update external outlook task

Methods inherited from class com.accela.aa.emse.dom.service.BaseAAScript

initScript

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.accela.aa.emse.dom.service.ScriptAble

initScript

Constructor Detail

CommunicationScript

public CommunicationScript()

CommunicationScript Constructor.

CommunicationScript

public CommunicationScript(java.lang.String serviceProviderCode,
                   java.lang.String auditID)
                    throws com.accela.aa.exception.AAException

CommunicationScript Constructor.

Parameters:

serviceProviderCode -

auditID -

Throws:

com.accela.aa.exception.AAException

Method Detail

createTask

public ScriptResult createTask(com.accela.aa.notification.model.CalendarTaskModel taskModel)

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

create external outlook task

Specified by:

createTask in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

deleteTask

public ScriptResult deleteTask(com.accela.aa.notification.model.CalendarTaskModel taskModel)

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

delete external outlook task

Specified by:

deleteTask in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

updateTask

public ScriptResult updateTask(com.accela.aa.notification.model.CalendarTaskModel taskModel)

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

update external outlook task

Specified by:

updateTask in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

getNewTaskModel

public ScriptResult getNewTaskModel()

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Returns a new TaskModel object.

Specified by:

getNewTaskModel in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

associateEnities

public ScriptResult associateEnities(java.lang.String communicationId,
                            java.lang.String entityId,
                            java.lang.String entityType)

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

associate entities.

Specified by:

associateEnities in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

getEmailMessageScriptModel

public ScriptResult getEmailMessageScriptModel()

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Return email message object.

Specified by:

getEmailMessageScriptModel in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

getSMSMessageScriptModel

public ScriptResult getSMSMessageScriptModel()

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Return sms message object.

Specified by:

getSMSMessageScriptModel in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

getNotificationTemplate

public ScriptResult getNotificationTemplate(java.lang.String templateName)
                                     throws com.accela.aa.exception.AAException

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Get notification template.

Specified by:

getNotificationTemplate in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

Throws:

com.accela.aa.exception.AAException

getNotificationTemplateModel

public ScriptResult getNotificationTemplateModel()

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Return notification template object.

Specified by:

getNotificationTemplateModel in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

sendMessage

public ScriptResult sendMessage(EmailMessageScriptModel messageScriptModel)
                         throws com.accela.aa.exception.AAException

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Send message by message model.

Specified by:

sendMessage in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

Throws:

com.accela.aa.exception.AAException

sendMessage

public ScriptResult sendMessage(SMSMessageScriptModel messageScriptModel)
                         throws com.accela.aa.exception.AAException

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Send message.

Specified by:

sendMessage in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Parameters:

messageScriptModel - the message script model

Returns:

the script result

Throws:

com.accela.aa.exception.AAException - the AA exception

sendMessages

public ScriptResult sendMessages(java.lang.String templateName,
                        java.util.Hashtable<java.lang.String,java.lang.String> variables,
                        java.lang.String triggerEvent)
                          throws com.accela.aa.exception.AAException

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Send message by notification template.

Specified by:

sendMessages in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

ScriptResult

Throws:

com.accela.aa.exception.AAException

sendMessages

public ScriptResult sendMessages(java.lang.String templateName,
                        java.util.Hashtable<java.lang.String,java.lang.String> variables,
                        java.lang.String triggerEvent,
                        java.lang.String[][] relatedEntities)
                          throws com.accela.aa.exception.AAException

Send messages. The param relatedEntities will be related to Email. The Example of relatedEntities: relatedEntities[][] ={{"RECORD","13CAP-00001033"},XXX}; The relatedEntities[0][0] should be "entityType". The relatedEntities[0][1] should be "AlterID". The relatedEntities[0].Length == 2 is require.

Specified by:

sendMessages in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Parameters:

templateName - the template name

variables - the variables

triggerEvent - the trigger event

relatedEntities - the related entities

Returns:

the script result

Throws:

com.accela.aa.exception.AAException - the AA exception

sendMessagesWithI18NParameters

public ScriptResult sendMessagesWithI18NParameters(java.lang.String templateName,
                                          java.util.Hashtable<java.lang.String,java.util.Hashtable<java.lang.String,java.lang.String>> i18nVariables,
                                          java.lang.String triggerEvent)
                                            throws com.accela.aa.exception.AAException

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Send message with I18N parameters

Specified by:

sendMessagesWithI18NParameters in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

Throws:

com.accela.aa.exception.AAException

getContactList

public ScriptResult getContactList(java.lang.String[][] params,
                          java.lang.String messageType)

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Get contanct list.

Specified by:

getContactList in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

resendFailedMessages

public ScriptResult resendFailedMessages(java.lang.String[] types)

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Resend failed messages.

Specified by:

resendFailedMessages in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns:

getI18nVariables

public ScriptResult getI18nVariables()

Description copied from interface: com.accela.aa.emse.dom.service.CommunicationScriptService

Get I18n variables.

Specified by:

getI18nVariables in interface com.accela.aa.emse.dom.service.CommunicationScriptService

Returns: