com.crm.process.communications

Class CRMProcessCommunicationBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMProcess

com.crm.process.communications.CRMProcessCommunicationBean

All Implemented Interfaces:

java.io.Serializable

public class CRMProcessCommunicationBean
extends CRMProcess

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMProcessCommunicationBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.communications.CRMDOCommunication	complete(com.crm.dataobject.communications.CRMDOCommunication communication) Complete communication process: The job's actual completed date is set Validate if communication can complete Stock out physical goods Validate and save communication
com.crm.dataobject.communications.CRMDOCommunication	complete(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Complete communication process: The job's actual completed date is set Validate if communication can complete Stock out physical goods Validate and save communication
void	completeQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue) Completes a communication queue
void	dynamicActionEmailTrack(java.lang.String action, java.lang.String communicationID, java.lang.String organisationID, java.lang.String token) Update a communication based on dynamic action
void	dynamicActionLinkTrack(java.lang.String action, java.lang.String link, java.lang.String communicationID, java.lang.String organisationID, java.lang.String token) Update a communication based on dynamic action
com.crm.dataobject.communications.CRMDOCommunicationDefinition	loadActiveDefinition() Loads the active communication definition
void	processQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue) Process a communication queue
void	processQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Process a communication queue
void	rejectQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue, java.lang.String errorCode, java.lang.String errorDescription) Rejects a communication queue
void	removeQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue) Removes a communication queue
com.crm.dataobject.communications.CRMDOCommunication	replaceDynamicLinks(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Replace the dynamic links on a communication's content
java.lang.Boolean	sendEmail(java.lang.String fromEmail, java.lang.String toEmailAddress, java.lang.String subject, java.lang.String message, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition, java.lang.String filesPath, java.util.ArrayList<com.crm.dataobject.CRMDO> attachments) Sends a communication through email
void	sendSMS(java.lang.String toPhone, java.lang.String message, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Sends SMS
void	sendSMS(java.lang.String toPhone, java.lang.String fromPhone, java.lang.String message, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Sends a communication through SMS
void	sendSMS(java.lang.String toPhone, java.lang.String fromPhone, java.lang.String message, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition, com.crm.dataobject.communications.CRMDOCommunication communication) Sends a communication through SMS
com.crm.dataobject.communications.CRMDOCommunication	setEmailTrackingInformation(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Set the email tracking information on a communication's content
com.crm.dataobject.communications.CRMDOCommunication	setTrackingInformationInBody(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Set the tracking information on a communication's content
com.crm.dataobject.communications.CRMDOCommunication	setTrackingSettings(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Set the tracking settings on a communication
java.lang.Boolean	testEmailConnection(com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition, java.lang.String testEmail) Tests email connection

Methods inherited from class com.crm.process.CRMProcess

createCronExpressionFromDate, createCronExpressionFromDate, setMandatoryField

Methods inherited from class com.crm.businessobject.CRMBase

deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object

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

Constructor Detail

CRMProcessCommunicationBean

public CRMProcessCommunicationBean()

Default constructor.

Method Detail

complete

public com.crm.dataobject.communications.CRMDOCommunication complete(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                              throws java.lang.Exception

Complete communication process: The job's actual completed date is set Validate if communication can complete Stock out physical goods Validate and save communication

Parameters:

communication - - the communication to complete

Returns:

the completed communication

Throws:

java.lang.Exception

complete

public com.crm.dataobject.communications.CRMDOCommunication complete(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                     com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
                                                              throws java.lang.Exception

Complete communication process: The job's actual completed date is set Validate if communication can complete Stock out physical goods Validate and save communication

Parameters:

communication - - the communication to complete

communicationDefinition - - the active communication definition

Returns:

the completed communication

Throws:

java.lang.Exception

setTrackingSettings

public com.crm.dataobject.communications.CRMDOCommunication setTrackingSettings(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
                                                                         throws java.lang.Exception

Set the tracking settings on a communication

Parameters:

communication - - the communication to update

communicationDefinition - - the active communication definition

Returns:

the updated communication

Throws:

java.lang.Exception

setTrackingInformationInBody

public com.crm.dataobject.communications.CRMDOCommunication setTrackingInformationInBody(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                         com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
                                                                                  throws java.lang.Exception

Set the tracking information on a communication's content

Parameters:

communication - - the communication to update

communicationDefinition - - the active communication definition

Returns:

the updated communication

Throws:

java.lang.Exception

replaceDynamicLinks

public com.crm.dataobject.communications.CRMDOCommunication replaceDynamicLinks(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
                                                                         throws java.lang.Exception

Replace the dynamic links on a communication's content

Parameters:

communication - - the communication to update

communicationDefinition - - the active communication definition

Returns:

the updated communication

Throws:

java.lang.Exception

setEmailTrackingInformation

public com.crm.dataobject.communications.CRMDOCommunication setEmailTrackingInformation(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                        com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
                                                                                 throws java.lang.Exception

Set the email tracking information on a communication's content

Parameters:

communication - - the communication to update

communicationDefinition - - the active communication definition

Returns:

the updated communication

Throws:

java.lang.Exception

processQueue

public void processQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue)
                  throws java.lang.Exception

Process a communication queue

Parameters:

communicationQueue - - the communication queue to process

Throws:

java.lang.Exception

processQueue

public void processQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue,
                         com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
                  throws java.lang.Exception

Process a communication queue

Parameters:

communicationQueue - - the communication queue to process

communicationDefinition - - the active communication definition

Throws:

java.lang.Exception

rejectQueue

public void rejectQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue,
                        java.lang.String errorCode,
                        java.lang.String errorDescription)
                 throws java.lang.Exception

Rejects a communication queue

Parameters:

communicationQueue - - the communication queue to reject

errorCode - - the error code of the rejection

errorDescription - - the description of the rejection

Throws:

java.lang.Exception

completeQueue

public void completeQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue)
                   throws java.lang.Exception

Completes a communication queue

Parameters:

communicationQueue - - the communication queue to reject

Throws:

java.lang.Exception

removeQueue

public void removeQueue(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue)
                 throws java.lang.Exception

Removes a communication queue

Parameters:

communicationQueue - - the communication queue to complete and remove

Throws:

java.lang.Exception

sendEmail

public java.lang.Boolean sendEmail(java.lang.String fromEmail,
                                   java.lang.String toEmailAddress,
                                   java.lang.String subject,
                                   java.lang.String message,
                                   com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition,
                                   java.lang.String filesPath,
                                   java.util.ArrayList<com.crm.dataobject.CRMDO> attachments)
                            throws java.lang.Exception

Sends a communication through email

Parameters:

fromEmail -

toEmailAddress -

subject -

message -

communicationDefinition -

filesPath -

attachments -

Returns:

true or false

Throws:

java.lang.Exception

testEmailConnection

public java.lang.Boolean testEmailConnection(com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition,
                                             java.lang.String testEmail)
                                      throws java.lang.Exception

Tests email connection

Parameters:

communicationDefinition - - the active communication definition

testEmail - - the email to test the connection

Throws:

java.lang.Exception

sendSMS

public void sendSMS(java.lang.String toPhone,
                    java.lang.String message,
                    com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
             throws java.lang.Exception

Sends SMS

Parameters:

toPhone - - the phone of recipient

message - - the message of sms

communicationDefinition - - the active communication definition

Throws:

java.lang.Exception

sendSMS

public void sendSMS(java.lang.String toPhone,
                    java.lang.String fromPhone,
                    java.lang.String message,
                    com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
             throws java.lang.Exception

Sends a communication through SMS

Parameters:

toPhone - - the phone of recipient

fromPhone - - the phone of sender

message - - the message of SMS

communicationDefinition - - the active communication definition

Throws:

java.lang.Exception

sendSMS

public void sendSMS(java.lang.String toPhone,
                    java.lang.String fromPhone,
                    java.lang.String message,
                    com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition,
                    com.crm.dataobject.communications.CRMDOCommunication communication)
             throws java.lang.Exception

Sends a communication through SMS

Parameters:

toPhone - - the phone of recipient

fromPhone - - the phone of sender

message - - the message of SMS

communicationDefinition - - the active communication definition

communication - - the communication to send the sms for

Throws:

java.lang.Exception

dynamicActionEmailTrack

public void dynamicActionEmailTrack(java.lang.String action,
                                    java.lang.String communicationID,
                                    java.lang.String organisationID,
                                    java.lang.String token)
                             throws java.lang.Exception

Update a communication based on dynamic action

Parameters:

action - - the action to execute

communicationID - - the id of the communication

organisationID - - the id of the organisation

token - - the token to validate the action

Throws:

java.lang.Exception

dynamicActionLinkTrack

public void dynamicActionLinkTrack(java.lang.String action,
                                   java.lang.String link,
                                   java.lang.String communicationID,
                                   java.lang.String organisationID,
                                   java.lang.String token)
                            throws java.lang.Exception

Update a communication based on dynamic action

Parameters:

action - - the action to execute

link - - the link

communicationID - - the id of the communication

organisationID - - the id of the organisation

token - - the token to validate the action

Throws:

java.lang.Exception

loadActiveDefinition

public com.crm.dataobject.communications.CRMDOCommunicationDefinition loadActiveDefinition()
                                                                                    throws java.lang.Exception

Loads the active communication definition

Returns:

returns the active communication definition

Throws:

java.lang.Exception