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.

Constructors
Constructor and Description
`CRMProcessCommunicationBean()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`anonymizeContactCommunications(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)` Anonymizes the given contact information communication
`com.crm.dataobject.communications.CRMDOCommunication`	`applyCommonOperations(com.crm.dataobject.communications.CRMDOCommunication communication)` Executes the common operations of a communication.
`com.crm.dataobject.communications.CRMDOCommunication`	`applyURLShortener(com.crm.dataobject.communications.CRMDOCommunication communication)` Applies a URL shortener to a communication.
`com.crm.dataobject.communications.CRMDOCommunication`	`assignReferringEntity(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.CRMDO mainDTO)` Assigns a related entity to a communication.
`com.crm.dataobject.communications.CRMDOCommunication`	communicateEntity(com.crm.dataobject.CRMDO mainDTO, java.lang.String recipient, java.lang.String subject, java.lang.String content, com.crm.dataobject.communications.CommunicationLifeCycleState lifeCycleState, java.util.Date expirationDate, com.crm.dataobject.communications.CRMDOCommunicationCategory category, com.crm.dataobject.communications.CommunicationMedia media, com.crm.dataobject.communications.CommunicationDirection direction, com.crm.dataobject.communications.CRMDOCommunicationTemplate communicationTemplate, com.crm.dataobject.communications.CRMDOCommunicationQueueExternalSystem queueExternalSystem, java.util.HashMap<java.lang.String,java.lang.Object> unboundParameters, com.crm.dataobject.communications.CRMDOCommunicationDefinition definition) Creates a communication for a referring entity.
`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
`com.crm.dataobject.communications.CRMDOCommunication`	`copyAttributesFromDefinition(com.crm.dataobject.communications.CRMDOCommunication communication)` Copies the default information of the active communication definition to a communication.
`com.crm.dataobject.communications.CRMDOCommunication`	`copyAttributesFromDefinition(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition definition)` Copies the default information of the active communication definition to a communication.
`com.crm.dataobject.communications.CRMDOCommunication`	`copyAttributesFromTemplate(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationTemplate template)` Copies a communication's template attributes into a communication.
`com.crm.dataobject.communications.CRMDOCommunication`	`create(com.crm.dataobject.communications.CRMDOCommunication communication)` Creates a communication.
`com.crm.dataobject.communications.CRMDOCommunication`	`delete(com.crm.dataobject.communications.CRMDOCommunication communication)` Deletes a communication.
`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.CRMDOCommunication`	`followUp(com.crm.dataobject.communications.CRMDOCommunication communication)` This process follows up a communication (does not save the followed up communication) Creates a followed up communication of a communication Sets followed up communication as Draft Set initial communication on followed up communication Copies default information from the active definition
`void`	`handleExternalLinks(java.lang.String action, java.lang.String entityID, java.lang.String organisationID, java.lang.String redirectionURL, java.lang.String token)` Handles the external links and updates the related entity based on the dynamic action.
`void`	`handleExternalLinks(java.lang.String action, java.lang.String entityID, java.lang.String contactInformationID, java.lang.String organisationID, java.lang.String redirectionURL, java.lang.String token)` Handles the external links and updates the related entity based on the dynamic action.
`com.crm.dataobject.communications.CRMDOCommunication`	`initialize(com.crm.dataobject.communications.CRMDOCommunication communication)` Initializes a communication with default values when needed.
`java.lang.Boolean`	`isAccessible(com.crm.dataobject.communications.CRMDOCommunication communication)` Determines if a communication is retrievable.
`java.lang.Boolean`	`isAccessible(com.crm.dataobject.communications.CRMDOCommunicationTrackingLink communicationTrackingLink)` Determines if a communication tracking link is retrievable.
`java.lang.Boolean`	`isAccessible(com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter communicationUnboundParameter)` Determines if a communication unbound parameter is retrievable.
`java.lang.Boolean`	`isExpired(com.crm.dataobject.communications.CRMDOCommunication communication)`
`java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunication>`	`list(com.crm.dataobject.communications.CommunicationSearchCriteria searchCriteria)` Lists communication objects based on the given criteria.
`java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunication>`	`listFollowUpCommunications(com.crm.dataobject.communications.CRMDOCommunication communication)` Lists follow up communications of the given communication.
`java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunication>`	`listFollowUpCommunications(com.crm.dataobject.communications.CRMDOCommunication communication, java.util.ArrayList<java.lang.String> associations)` Lists follow up communications of the given communication.
`java.util.ArrayList<com.crm.framework.metadata.Entity>`	`listRelatedEntities(com.crm.dataobject.communications.CRMDOCommunication communication)` Loads the communication related entities
`java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunicationTrackingLink>`	`listTrackingLinks(com.crm.dataobject.communications.CRMDOCommunication communication)` Lists the tracking links of the given communication.
`java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunicationTrackingLink>`	`listTrackingLinks(com.crm.dataobject.communications.CRMDOCommunication communication, java.util.ArrayList<java.lang.String> associations)` Lists the tracking links of the given communication.
`java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter>`	`listUnboundParameters(com.crm.dataobject.communications.CRMDOCommunication communication)` Lists the unbound parameters of the given communication.
`java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter>`	`listUnboundParameters(com.crm.dataobject.communications.CRMDOCommunication communication, java.util.ArrayList<java.lang.String> associations)` Lists the unbound parameters of the given communication.
`com.crm.dataobject.communications.CRMDOCommunication`	`newCommunication(com.crm.dataobject.CRMDO mainDTO)` Instantiates and initializes a new communication.
`com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter`	`newUnboundParameter(com.crm.dataobject.communications.CRMDOCommunication communication)` Instantiates and initializes a new communication unbound parameter.
`com.crm.dataobject.communications.CRMDOCommunication`	`read(com.crm.dataobject.notifications.CRMDONotification notification)` Reads a communication by specifying the notification.
`com.crm.dataobject.communications.CRMDOCommunication`	`read(com.crm.dataobject.notifications.CRMDONotification notification, java.util.ArrayList<java.lang.String> associations)` Reads a communication by specifying the notification.
`com.crm.dataobject.communications.CRMDOCommunication`	`read(java.lang.String id)` Reads a communication by specifying the communication ID.
`com.crm.dataobject.communications.CRMDOCommunication`	`read(java.lang.String id, java.util.ArrayList<java.lang.String> associations)` Reads a communication by specifying the communication ID.
`com.crm.dataobject.communications.CRMDOCommunication`	`readByNumber(java.lang.String number)` Reads a communication by specifying the communication number.
`com.crm.dataobject.communications.CRMDOCommunication`	`readByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations)` Reads a communication by specifying the communication number.
`com.crm.dataobject.communications.CRMDOCommunicationTrackingLink`	`readTrackingLink(com.crm.dataobject.communications.CRMDOCommunication communication, java.lang.String url)` Reads a communication tracking link by specifying the related communication and a url.
`com.crm.dataobject.communications.CRMDOCommunicationTrackingLink`	`readTrackingLink(com.crm.dataobject.communications.CRMDOCommunication communication, java.lang.String url, java.util.ArrayList<java.lang.String> associations)` Reads a communication tracking link by specifying the related communication and a url.
`com.crm.dataobject.communications.CRMDOCommunicationTrackingLink`	`readTrackingLink(java.lang.String id)` Reads a communication tracking link by specifying the tracking link ID.
`com.crm.dataobject.communications.CRMDOCommunicationTrackingLink`	`readTrackingLink(java.lang.String id, java.util.ArrayList<java.lang.String> associations)` Reads a communication tracking link by specifying the tracking link ID.
`com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter`	`readUnboundParameter(java.lang.String id)` Reads a communication unbound parameter by specifying the unbound parameter ID.
`com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter`	`readUnboundParameter(java.lang.String id, java.util.ArrayList<java.lang.String> associations)` Reads a communication unbound parameter by specifying the unbound parameter ID.
`com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter`	`readUnboundParameterByKey(java.lang.String key, com.crm.dataobject.communications.CRMDOCommunication communication)` Reads a communication unbound parameter by specifying the unbound parameter key and the related communication.
`com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter`	`readUnboundParameterByKey(java.lang.String key, com.crm.dataobject.communications.CRMDOCommunication communication, java.util.ArrayList<java.lang.String> associations)` Reads a communication unbound parameter by specifying the unbound parameter key and the related communication.
`com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter`	`readUnboundParameterByName(java.lang.String name, com.crm.dataobject.communications.CRMDOCommunication communication)` Reads a communication tracking link by specifying the unbound parameter name and the related communication.
`com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter`	`readUnboundParameterByName(java.lang.String name, com.crm.dataobject.communications.CRMDOCommunication communication, java.util.ArrayList<java.lang.String> associations)` Reads a communication unbound parameter by specifying the unbound parameter name and the related communication.
`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
`com.crm.dataobject.communications.CRMDOCommunication`	`replaceTags(com.crm.dataobject.communications.CRMDOCommunication communication)` Replace the tags of a communication.
`void`	`sendCommunications(AccessTokenRequiresVerificationEvent communicationEvent)`
`void`	`sendCommunications(AccountReceivableActivateEvent communicationEvent)`
`void`	`sendCommunications(AccountReceivableAddMemberInGroupEvent communicationEvent)`
`void`	`sendCommunications(AccountReceivableRemoveMemberFromGroupEvent communicationEvent)`
`void`	`sendCommunications(AccountReceivableSuspendEvent communicationEvent)`
`void`	`sendCommunications(AccountReceivableTerminateEvent communicationEvent)`
`void`	`sendCommunications(AccountReceivableUpdateEvent communicationEvent)`
`void`	`sendCommunications(ActivityCancellationEvent communicationEvent)`
`void`	`sendCommunications(ActivityCompletionEvent communicationEvent)`
`void`	`sendCommunications(ActivityCreationEvent communicationEvent)`
`void`	`sendCommunications(ActivityStartProgressEvent communicationEvent)`
`void`	`sendCommunications(ActivityUpdateEvent communicationEvent)`
`void`	`sendCommunications(java.util.ArrayList<com.crm.dataobject.communications.CommunicationInfo> communicationsInfo)`
`void`	`sendCommunications(AssignAccessTokenToAccountEvent communicationEvent)`
`void`	`sendCommunications(AssignKYCProfileEvent communicationEvent)`
`void`	`sendCommunications(AutoGenerateAccessTokenPassCodeForAccountEvent communicationEvent)`
`void`	`sendCommunications(CancelElectronicVoucherEvent communicationEvent)`
`void`	`sendCommunications(CancelJobEvent communicationEvent)`
`void`	`sendCommunications(CancelMemberElectronicVoucherEvent communicationEvent)`
`void`	`sendCommunications(CancelMemberJobEvent communicationEvent)`
`void`	`sendCommunications(CancelMemberPrintedVoucherEvent communicationEvent)`
`void`	`sendCommunications(CancelPrintedVoucherEvent communicationEvent)`
`void`	`sendCommunications(CompleteJobEvent communicationEvent)`
`void`	`sendCommunications(CompleteMemberJobEvent communicationEvent)`
`void`	`sendCommunications(CompleteMemberServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(CompleteServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(CreateContactInformationEvent communicationEvent)`
`void`	`sendCommunications(CreateCreditWalletTransactionEvent communicationEvent)`
`void`	`sendCommunications(CreateDebitWalletTransactionEvent communicationEvent)`
`void`	`sendCommunications(CreateJobEvent communicationEvent)`
`void`	`sendCommunications(CreateMemberCreditWalletTransactionEvent communicationEvent)`
`void`	`sendCommunications(CreateMemberDebitWalletTransactionEvent communicationEvent)`
`void`	`sendCommunications(CreateMemberJobEvent communicationEvent)`
`void`	`sendCommunications(CreateMemberServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(CreateServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(DistributePromotionCodeEvent communicationEvent)`
`void`	`sendCommunications(ExpireKYCProfileEvent communicationEvent)`
`void`	`sendCommunications(FinalResolveMemberServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(FinalResolveServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(IssueMemberRefundVoucherEvent communicationEvent)`
`void`	`sendCommunications(IssueRefundVoucherEvent communicationEvent)`
`void`	`sendCommunications(JobQuotationOnCreateJobEvent communicationEvent)`
`void`	`sendCommunications(JobQuotationOnCreateMemberJobEvent communicationEvent)`
`void`	`sendCommunications(JobQuotationOnSettingJobAsPendingEvent communicationEvent)`
`void`	`sendCommunications(JobQuotationOnSettingMemberJobAsPendingEvent communicationEvent)`
`void`	`sendCommunications(JobQuotationOnStartProgressJobEvent communicationEvent)`
`void`	`sendCommunications(JobQuotationOnStartProgressMemberJobEvent communicationEvent)`
`void`	`sendCommunications(JobQuotationOnUpdateJobEvent communicationEvent)`
`void`	`sendCommunications(JobQuotationOnUpdateMemberJobEvent communicationEvent)`
`void`	`sendCommunications(LeadCancellationEvent communicationEvent)`
`void`	`sendCommunications(LeadCreationEvent communicationEvent)`
`void`	`sendCommunications(LeadLostEvent communicationEvent)`
`void`	`sendCommunications(LeadStartProgressEvent communicationEvent)`
`void`	`sendCommunications(LeadUpdateEvent communicationEvent)`
`void`	`sendCommunications(LeadWinEvent communicationEvent)`
`void`	`sendCommunications(MemberAccountReceivableActivateEvent communicationEvent)`
`void`	`sendCommunications(MemberAccountReceivableAddMemberInGroupEvent communicationEvent)`
`void`	`sendCommunications(MemberAccountReceivableRemoveMemberFromGroupEvent communicationEvent)`
`void`	`sendCommunications(MemberAccountReceivableSuspendEvent communicationEvent)`
`void`	`sendCommunications(MemberAccountReceivableTerminateEvent communicationEvent)`
`void`	`sendCommunications(MemberAccountReceivableUpdateEvent communicationEvent)`
`void`	`sendCommunications(MemberPurchaseCustomerEventSubmissionEvent communicationEvent)`
`void`	`sendCommunications(MemberRewardParticipantSignUpEvent communicationEvent)`
`void`	`sendCommunications(MemberRewardSchemeSignUpEvent communicationEvent)`
`void`	`sendCommunications(MemberSpendRequestCustomerEventSubmissionEvent communicationEvent)`
`void`	`sendCommunications(MemberSubscriptionEvent communicationEvent)`
`void`	`sendCommunications(MemberTransferFromAccountToWalletEvent communicationEvent)`
`void`	`sendCommunications(MemberTransferFromWalletToAccountEvent communicationEvent)`
`void`	`sendCommunications(NotifyEntityEvent communicationEvent)`
`void`	`sendCommunications(PostAwardExpirationTransactionEvent communicationEvent)`
`void`	`sendCommunications(PostAwardTransactionEvent communicationEvent)`
`void`	`sendCommunications(PostMemberAwardExpirationTransactionEvent communicationEvent)`
`void`	`sendCommunications(PostMemberAwardTransactionEvent communicationEvent)`
`void`	`sendCommunications(PostMemberPaymentEvent communicationEvent)`
`void`	`sendCommunications(PostMemberPaymentGatewayRequestFailureEvent communicationEvent)`
`void`	`sendCommunications(PostMemberRefundEvent communicationEvent)`
`void`	`sendCommunications(PostMemberSpendTransactionEvent communicationEvent)`
`void`	`sendCommunications(PostPaymentCommunicationEvent communicationEvent)`
`void`	`sendCommunications(PostPaymentGatewayRequestFailureEvent communicationEvent)`
`void`	`sendCommunications(PostRefundEvent communicationEvent)`
`void`	`sendCommunications(PostSpendTransactionEvent communicationEvent)`
`void`	`sendCommunications(PurchaseCustomerEventSubmissionEvent communicationEvent)`
`void`	`sendCommunications(PurchaseElectronicVoucherEvent communicationEvent)`
`void`	`sendCommunications(PurchaseMemberElectronicVoucherEvent communicationEvent)`
`void`	`sendCommunications(RefuteKYCProfileEvent communicationEvent)`
`void`	`sendCommunications(RequestMemberRewardsSchemeReferenceCodeEvent communicationEvent)`
`void`	`sendCommunications(RequestRewardsSchemeReferenceCodeEvent communicationEvent)`
`void`	`sendCommunications(ResetAccessTokenPassCodeEvent communicationEvent)`
`void`	`sendCommunications(ResetAccessTokenVerificationCodeEvent communicationEvent)`
`void`	`sendCommunications(RespondMemberServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(RespondServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(RewardParticipantSignUpEvent communicationEvent)`
`void`	`sendCommunications(RewardSchemeSignUpEvent communicationEvent)`
`void`	`sendCommunications(SpendRequestCustomerEventSubmissionEvent communicationEvent)`
`void`	`sendCommunications(StartProgressJobEvent communicationEvent)`
`void`	`sendCommunications(StartProgressMemberJobEvent communicationEvent)`
`void`	`sendCommunications(SubscriptionEvent communicationEvent)`
`void`	`sendCommunications(TemporaryResolveMemberServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(TemporaryResolveServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(TransferFromAccountToWalletEvent communicationEvent)`
`void`	`sendCommunications(TransferFromWalletToAccount communicationEvent)`
`void`	`sendCommunications(UpdateContactInformationEvent communicationEvent)`
`void`	`sendCommunications(UpdateJobEvent communicationEvent)`
`void`	`sendCommunications(UpdateMemberJobEvent communicationEvent)`
`void`	`sendCommunications(UpdateMemberServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(UpdateServiceRequestEvent communicationEvent)`
`void`	`sendCommunications(UseElectronicVoucherEvent communicationEvent)`
`void`	`sendCommunications(UseMemberElectronicVoucherEvent communicationEvent)`
`void`	`sendCommunications(UseMemberPrintedVoucherEvent communicationEvent)`
`void`	`sendCommunications(UsePrintedVoucherEvent communicationEvent)`
`void`	`sendCommunications(VerifyAccessTokenEvent communicationEvent)`
`void`	`sendCommunications(VerifyKYCProfileEvent communicationEvent)`
`void`	`sendEmail(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)` Sends a communication through email
`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(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)` Sends a communication through SMS
`void`	`sendSMS(java.lang.String toPhone, 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)` 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`	`setAsViewed(com.crm.dataobject.communications.CRMDOCommunication communication, java.util.Date viewedOn)` Sets a communication as viewed by the recipient.
`com.crm.dataobject.communications.CRMDOCommunication`	`update(com.crm.dataobject.communications.CRMDOCommunication communication)` Updates a communication.
`void`	`validateCompletion(com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)` Validates the completion of a communication.
`void`	`validateTemplate(com.crm.dataobject.communications.CRMDOCommunication communication)` Validates that required referring entities are specified in the communication.

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, loadEntityCategories, loadEntityNumber, loadEntityStates, loadEntityStatuses, loadEntityTypes, rollback, 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

applyCommonOperations
```
public com.crm.dataobject.communications.CRMDOCommunication applyCommonOperations(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                           throws java.lang.Exception,
                                                                                  com.crm.exception.CannotAccessEntityException
```
Executes the common operations of a communication. This process validates that: - Specified communication is accessible - Mandatory fields are specified - Unique fields are validated - Referring to entities are validated

Parameters:

communication - - the communication for which common operations will be executed

Returns:

the validated communication

Throws:

java.lang.Exception

com.crm.exception.CannotAccessEntityException

validateTemplate

public void validateTemplate(com.crm.dataobject.communications.CRMDOCommunication communication)
                      throws java.lang.Exception,
                             com.crm.exception.communications.MissingReferringEntitiesException

Validates that required referring entities are specified in the communication.

Parameters:: communication - - the communication to validate
Throws:: java.lang.Exception; com.crm.exception.communications.MissingReferringEntitiesException

isAccessible
```
public java.lang.Boolean isAccessible(com.crm.dataobject.communications.CRMDOCommunication communication)
                               throws java.lang.Exception
```
Determines if a communication is retrievable.

Parameters:

communication - - the communication to determine whether it is accessible or not

Returns:

true if the given communication is accessible, otherwise false

Throws:

java.lang.Exception

initialize

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

Initializes a communication with default values when needed.

Parameters:: communication - - the communication to initialize
Returns:: the updated communication
Throws:: java.lang.Exception

newCommunication

public com.crm.dataobject.communications.CRMDOCommunication newCommunication(com.crm.dataobject.CRMDO mainDTO)
                                                                      throws java.lang.Exception

Instantiates and initializes a new communication.

Parameters:: mainDTO - - the main data object
Returns:: the communication
Throws:: java.lang.Exception

communicateEntity

public com.crm.dataobject.communications.CRMDOCommunication communicateEntity(com.crm.dataobject.CRMDO mainDTO,
                                                                              java.lang.String recipient,
                                                                              java.lang.String subject,
                                                                              java.lang.String content,
                                                                              com.crm.dataobject.communications.CommunicationLifeCycleState lifeCycleState,
                                                                              java.util.Date expirationDate,
                                                                              com.crm.dataobject.communications.CRMDOCommunicationCategory category,
                                                                              com.crm.dataobject.communications.CommunicationMedia media,
                                                                              com.crm.dataobject.communications.CommunicationDirection direction,
                                                                              com.crm.dataobject.communications.CRMDOCommunicationTemplate communicationTemplate,
                                                                              com.crm.dataobject.communications.CRMDOCommunicationQueueExternalSystem queueExternalSystem,
                                                                              java.util.HashMap<java.lang.String,java.lang.Object> unboundParameters,
                                                                              com.crm.dataobject.communications.CRMDOCommunicationDefinition definition)
                                                                       throws java.lang.Exception

Creates a communication for a referring entity.

Parameters:: mainDTO - - the referring entity to create the communication for; recipient - - the recipient of the communication; subject - - the subject of the communication; content - - the content of the communication; lifeCycleState - - the life cycle state of the communication; expirationDate - - the expiration date of the communication; category - - the category of the communication; media - - the media of the communication; direction - - the direction of the communication; communicationTemplate - - the template of the communication; queueExternalSystem - - the external system that should process the communication; unboundParameters - - the list of unbound parameters; definition - - the active communication definition
Returns:: the communication
Throws:: java.lang.Exception

assignReferringEntity

public com.crm.dataobject.communications.CRMDOCommunication assignReferringEntity(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                  com.crm.dataobject.CRMDO mainDTO)
                                                                           throws java.lang.Exception,
                                                                                  com.crm.exception.MandatoryFieldException

Assigns a related entity to a communication.

Parameters:: mainDTO - - the main data object
Returns:: the updated communication
Throws:: java.lang.Exception; com.crm.exception.MandatoryFieldException

create

public com.crm.dataobject.communications.CRMDOCommunication create(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                            throws java.lang.Exception,
                                                                   com.crm.exception.CannotCreateException

Creates a communication.

Parameters:: communication - - the communication to create
Returns:: the created communication
Throws:: java.lang.Exception; com.crm.exception.CannotCreateException

update

public com.crm.dataobject.communications.CRMDOCommunication update(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                            throws java.lang.Exception,
                                                                   com.crm.exception.CannotUpdateEntityException

Updates a communication.

Parameters:: communication - - the communication to update
Returns:: the updated communication
Throws:: java.lang.Exception; com.crm.exception.CannotUpdateEntityException

delete

public com.crm.dataobject.communications.CRMDOCommunication delete(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                            throws java.lang.Exception,
                                                                   com.crm.exception.CannotAccessEntityException,
                                                                   com.crm.exception.communications.CannotDeleteException

Deletes a communication.

Parameters:: communication - - the communication to delete
Returns:: the deleted communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException; com.crm.exception.communications.CannotDeleteException

read

public com.crm.dataobject.communications.CRMDOCommunication read(java.lang.String id)
                                                          throws java.lang.Exception,
                                                                 com.crm.exception.CannotAccessEntityException

Reads a communication by specifying the communication ID.

Parameters:: id - - the communication ID
Returns:: the communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

read

public com.crm.dataobject.communications.CRMDOCommunication read(java.lang.String id,
                                                                 java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception,
                                                                 com.crm.exception.CannotAccessEntityException

Reads a communication by specifying the communication ID.

Parameters:: id - - the communication ID; associations - - a list of associated data objects
Returns:: the communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

readByNumber

public com.crm.dataobject.communications.CRMDOCommunication readByNumber(java.lang.String number)
                                                                  throws java.lang.Exception,
                                                                         com.crm.exception.CannotAccessEntityException

Reads a communication by specifying the communication number.

Parameters:: number - - the communication number
Returns:: the communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

readByNumber

public com.crm.dataobject.communications.CRMDOCommunication readByNumber(java.lang.String number,
                                                                         java.util.ArrayList<java.lang.String> associations)
                                                                  throws java.lang.Exception,
                                                                         com.crm.exception.CannotAccessEntityException

Reads a communication by specifying the communication number.

Parameters:: number - - the communication number; associations - - a list of associated data objects
Returns:: the communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

read

public com.crm.dataobject.communications.CRMDOCommunication read(com.crm.dataobject.notifications.CRMDONotification notification)
                                                          throws java.lang.Exception,
                                                                 com.crm.exception.CannotAccessEntityException

Reads a communication by specifying the notification.

Parameters:: notification - - the communication notification
Returns:: the communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

read

public com.crm.dataobject.communications.CRMDOCommunication read(com.crm.dataobject.notifications.CRMDONotification notification,
                                                                 java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception,
                                                                 com.crm.exception.CannotAccessEntityException

Reads a communication by specifying the notification.

Parameters:: notification - - the communication notification; associations - - a list of associated data objects
Returns:: the communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

list

public java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunication> list(com.crm.dataobject.communications.CommunicationSearchCriteria searchCriteria)
                                                                               throws java.lang.Exception

Lists communication objects based on the given criteria.

Parameters:: searchCriteria - - the criteria that will be used to load the communication objects
Returns:: a list of communications that match the given criteria
Throws:: java.lang.Exception

listFollowUpCommunications

public java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunication> listFollowUpCommunications(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                                                     throws java.lang.Exception

Lists follow up communications of the given communication.

Parameters:: communication - - the communication to load the follow up communications for
Returns:: a list of follow up communications
Throws:: java.lang.Exception

listFollowUpCommunications

public java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunication> listFollowUpCommunications(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                                            java.util.ArrayList<java.lang.String> associations)
                                                                                                     throws java.lang.Exception

Lists follow up communications of the given communication.

Parameters:: communication - - the communication to load the follow up communications for; associations - - a list of associated data objects
Returns:: a list of follow up communications
Throws:: java.lang.Exception

setAsViewed

public com.crm.dataobject.communications.CRMDOCommunication setAsViewed(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                        java.util.Date viewedOn)
                                                                 throws java.lang.Exception,
                                                                        com.crm.exception.CannotAccessEntityException,
                                                                        com.crm.exception.communications.CommunicationIsNotCompletedException

Sets a communication as viewed by the recipient. Validates that communication is accessible Validates that the communication is completed Sets the communication as viewed and sets the viewed date Saves the communication

Parameters:: communication - - the communication to set as viewed; viewedOn - - the date that communication viewed
Returns:: the updated communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException; com.crm.exception.communications.CommunicationIsNotCompletedException

followUp
```
public com.crm.dataobject.communications.CRMDOCommunication followUp(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                              throws java.lang.Exception
```
This process follows up a communication (does not save the followed up communication) Creates a followed up communication of a communication Sets followed up communication as Draft Set initial communication on followed up communication Copies default information from the active definition

Parameters:

communication - - the communication to follow up

Returns:

the followed up communication

Throws:

java.lang.Exception

replaceTags

public com.crm.dataobject.communications.CRMDOCommunication replaceTags(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                 throws java.lang.Exception,
                                                                        com.crm.exception.CannotAccessEntityException

Replace the tags of a communication.

Parameters:: communication - - the communication to replace the tags for
Returns:: the updated communication
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

copyAttributesFromTemplate

public com.crm.dataobject.communications.CRMDOCommunication copyAttributesFromTemplate(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                       com.crm.dataobject.communications.CRMDOCommunicationTemplate template)
                                                                                throws java.lang.Exception

Copies a communication's template attributes into a communication.

Parameters:: communication - - the communication to copy the template attributes; template - - a communication template
Returns:: the communication with the copied communication template attributes
Throws:: java.lang.Exception

copyAttributesFromDefinition

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

Copies the default information of the active communication definition to a communication.

Parameters:: communication - - the communication to set the default information
Returns:: the updated communication
Throws:: java.lang.Exception

copyAttributesFromDefinition

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

Copies the default information of the active communication definition to a communication.

Parameters:: communication - - the communication to set the default information; definition - - the active communication definition
Returns:: the updated communication
Throws:: java.lang.Exception

validateCompletion

public void validateCompletion(com.crm.dataobject.communications.CRMDOCommunication communication,
                               com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
                        throws java.lang.Exception,
                               com.crm.exception.communications.AlreadyCompletedException,
                               com.crm.exception.communications.ContentLimitException

Validates the completion of a communication.

Parameters:: communication - - the communication to validate; communicationDefinition - - the active communication definition
Throws:: java.lang.Exception; com.crm.exception.communications.AlreadyCompletedException; com.crm.exception.communications.ContentLimitException

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

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

sendEmail

public void sendEmail(com.crm.dataobject.communications.CRMDOCommunication communication,
                      com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)
               throws java.lang.Exception,
                      com.crm.exception.communications.CommunicationExpirationException

Sends a communication through email

Parameters:: communication - - the communication to send; communicationDefinition - - the active communication definition
Throws:: java.lang.Exception; com.crm.exception.communications.CommunicationExpirationException

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

sendSMS

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

Sends a communication through SMS

Parameters:: communicationDefinition - - the active communication definition
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 a communication through 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,
                    com.crm.exception.communications.CommunicationExpirationException

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; com.crm.exception.communications.CommunicationExpirationException

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

sendCommunications

public void sendCommunications(CreateContactInformationEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UpdateContactInformationEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(VerifyKYCProfileEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AssignKYCProfileEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(RefuteKYCProfileEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(ExpireKYCProfileEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(ActivityCreationEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(ActivityUpdateEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(ActivityStartProgressEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(ActivityCompletionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(ActivityCancellationEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(LeadCreationEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(LeadUpdateEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(LeadStartProgressEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(LeadWinEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(LeadLostEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(LeadCancellationEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CreateJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CreateMemberJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UpdateJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UpdateMemberJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(StartProgressJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(StartProgressMemberJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CancelJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CancelMemberJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CompleteJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CompleteMemberJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CreateServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CreateMemberServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UpdateServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UpdateMemberServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(RespondServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(RespondMemberServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(TemporaryResolveServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(TemporaryResolveMemberServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(FinalResolveServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(FinalResolveMemberServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CompleteServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CompleteMemberServiceRequestEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AccountReceivableUpdateEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberAccountReceivableUpdateEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AccountReceivableTerminateEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberAccountReceivableTerminateEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AccountReceivableSuspendEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberAccountReceivableSuspendEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AccountReceivableActivateEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberAccountReceivableActivateEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AccountReceivableAddMemberInGroupEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberAccountReceivableAddMemberInGroupEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AccountReceivableRemoveMemberFromGroupEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberAccountReceivableRemoveMemberFromGroupEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PurchaseCustomerEventSubmissionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberPurchaseCustomerEventSubmissionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(SpendRequestCustomerEventSubmissionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberSpendRequestCustomerEventSubmissionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostPaymentCommunicationEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostMemberPaymentEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostRefundEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostMemberRefundEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CreateCreditWalletTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CreateMemberCreditWalletTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CreateDebitWalletTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CreateMemberDebitWalletTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(TransferFromAccountToWalletEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberTransferFromAccountToWalletEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(TransferFromWalletToAccount communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberTransferFromWalletToAccountEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostAwardTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostMemberAwardTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostSpendTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostMemberSpendTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostAwardExpirationTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostMemberAwardExpirationTransactionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(RewardParticipantSignUpEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberRewardParticipantSignUpEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(RewardSchemeSignUpEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberRewardSchemeSignUpEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(SubscriptionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(MemberSubscriptionEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PurchaseElectronicVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PurchaseMemberElectronicVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UseElectronicVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UseMemberElectronicVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CancelElectronicVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CancelMemberElectronicVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UsePrintedVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(UseMemberPrintedVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CancelPrintedVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(CancelMemberPrintedVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(IssueRefundVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(IssueMemberRefundVoucherEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(JobQuotationOnCreateJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(JobQuotationOnCreateMemberJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(JobQuotationOnStartProgressJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(JobQuotationOnStartProgressMemberJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(JobQuotationOnSettingJobAsPendingEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(JobQuotationOnSettingMemberJobAsPendingEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(JobQuotationOnUpdateJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(JobQuotationOnUpdateMemberJobEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostPaymentGatewayRequestFailureEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(PostMemberPaymentGatewayRequestFailureEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(DistributePromotionCodeEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(NotifyEntityEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(RequestRewardsSchemeReferenceCodeEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(RequestMemberRewardsSchemeReferenceCodeEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AssignAccessTokenToAccountEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AutoGenerateAccessTokenPassCodeForAccountEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(ResetAccessTokenPassCodeEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(ResetAccessTokenVerificationCodeEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(AccessTokenRequiresVerificationEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(VerifyAccessTokenEvent communicationEvent)
                        throws java.lang.Exception

Throws:: java.lang.Exception

sendCommunications

public void sendCommunications(java.util.ArrayList<com.crm.dataobject.communications.CommunicationInfo> communicationsInfo)
                        throws java.lang.Exception

Throws:: java.lang.Exception

anonymizeContactCommunications
```
public void anonymizeContactCommunications(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)
                                    throws java.lang.Exception
```
Anonymizes the given contact information communication

Parameters:

contact - - the contact information to anonymize its communication

Throws:

java.lang.Exception

handleExternalLinks

public void handleExternalLinks(java.lang.String action,
                                java.lang.String entityID,
                                java.lang.String organisationID,
                                java.lang.String redirectionURL,
                                java.lang.String token)
                         throws java.lang.Exception,
                                com.crm.exception.InvalidLinkException

Handles the external links and updates the related entity based on the dynamic action.

Parameters:: action - - the action to execute; entityID - - the id of the entity to update; organisationID - - the id of the organisation; redirectionURL - - the redirection URL; token - - the token to validate the action
Throws:: java.lang.Exception; com.crm.exception.InvalidLinkException

handleExternalLinks

public void handleExternalLinks(java.lang.String action,
                                java.lang.String entityID,
                                java.lang.String contactInformationID,
                                java.lang.String organisationID,
                                java.lang.String redirectionURL,
                                java.lang.String token)
                         throws java.lang.Exception,
                                com.crm.exception.InvalidLinkException

Handles the external links and updates the related entity based on the dynamic action.

Parameters:: action - - the action to execute; entityID - - the id of the entity to update; contactInformationID - - the id of the contact information; organisationID - - the id of the organisation; redirectionURL - - the redirection URL; token - - the token to validate the action
Throws:: java.lang.Exception; com.crm.exception.InvalidLinkException

applyURLShortener

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

Applies a URL shortener to a communication.

Parameters:: communication - - the communication to apply the URL shortener for
Returns:: the updated communication
Throws:: java.lang.Exception

isExpired

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

Throws:: java.lang.Exception

newUnboundParameter

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

Instantiates and initializes a new communication unbound parameter.

Parameters:: communication - - the communication to create the communication unbound parameter for
Returns:: the communication unbound parameter
Throws:: java.lang.Exception

isAccessible
```
public java.lang.Boolean isAccessible(com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter communicationUnboundParameter)
                               throws java.lang.Exception
```
Determines if a communication unbound parameter is retrievable.

Parameters:

communicationUnboundParameter - - the communication unbound parameter to determine whether it is accessible or not

Returns:

true if the given communication unbound parameter is accessible, otherwise false

Throws:

java.lang.Exception

readUnboundParameter

public com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter readUnboundParameter(java.lang.String id)
                                                                                          throws java.lang.Exception

Reads a communication unbound parameter by specifying the unbound parameter ID.

Parameters:: id - - the communication unbound parameter ID
Returns:: the communication unbound parameter
Throws:: java.lang.Exception

readUnboundParameter

public com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter readUnboundParameter(java.lang.String id,
                                                                                                 java.util.ArrayList<java.lang.String> associations)
                                                                                          throws java.lang.Exception

Reads a communication unbound parameter by specifying the unbound parameter ID.

Parameters:: id - - the communication unbound parameter ID; associations - - a list of associated data objects
Returns:: the communication unbound parameter
Throws:: java.lang.Exception

readUnboundParameterByKey

public com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter readUnboundParameterByKey(java.lang.String key,
                                                                                                      com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                                               throws java.lang.Exception

Reads a communication unbound parameter by specifying the unbound parameter key and the related communication.

Parameters:: key - - the communication unbound parameter key; communication - - the related communication
Returns:: the communication unbound parameter
Throws:: java.lang.Exception

readUnboundParameterByKey

public com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter readUnboundParameterByKey(java.lang.String key,
                                                                                                      com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                                      java.util.ArrayList<java.lang.String> associations)
                                                                                               throws java.lang.Exception

Reads a communication unbound parameter by specifying the unbound parameter key and the related communication.

Parameters:: key - - the communication unbound parameter key; communication - - the related communication; associations - - a list of associated data objects
Returns:: the communication unbound parameter
Throws:: java.lang.Exception

readUnboundParameterByName

public com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter readUnboundParameterByName(java.lang.String name,
                                                                                                       com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                                                throws java.lang.Exception

Reads a communication tracking link by specifying the unbound parameter name and the related communication.

Parameters:: name - - the communication unbound parameter name; communication - - the related communication
Returns:: the communication unbound parameter
Throws:: java.lang.Exception

readUnboundParameterByName

public com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter readUnboundParameterByName(java.lang.String name,
                                                                                                       com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                                       java.util.ArrayList<java.lang.String> associations)
                                                                                                throws java.lang.Exception

Reads a communication unbound parameter by specifying the unbound parameter name and the related communication.

Parameters:: name - - the communication unbound parameter name; communication - - the related communication; associations - - a list of associated data objects
Returns:: the communication unbound parameter
Throws:: java.lang.Exception

listUnboundParameters

public java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter> listUnboundParameters(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                                                                throws java.lang.Exception

Lists the unbound parameters of the given communication.

Parameters:: communication - - the communication to load the unbound parameters for
Returns:: a list of unbound parameters
Throws:: java.lang.Exception

listUnboundParameters

public java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunicationUnboundParameter> listUnboundParameters(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                                                       java.util.ArrayList<java.lang.String> associations)
                                                                                                                throws java.lang.Exception

Lists the unbound parameters of the given communication.

Parameters:: communication - - the communication to load the unbound parameters for; associations - - a list of associated data objects
Returns:: a list of unbound parameters
Throws:: java.lang.Exception

readTrackingLink

public com.crm.dataobject.communications.CRMDOCommunicationTrackingLink readTrackingLink(java.lang.String id)
                                                                                  throws java.lang.Exception,
                                                                                         com.crm.exception.CannotAccessEntityException

Reads a communication tracking link by specifying the tracking link ID.

Parameters:: id - - the communication tracking link ID
Returns:: the communication tracking link
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

readTrackingLink

public com.crm.dataobject.communications.CRMDOCommunicationTrackingLink readTrackingLink(java.lang.String id,
                                                                                         java.util.ArrayList<java.lang.String> associations)
                                                                                  throws java.lang.Exception,
                                                                                         com.crm.exception.CannotAccessEntityException

Reads a communication tracking link by specifying the tracking link ID.

Parameters:: id - - the communication tracking link ID; associations - - a list of associated data objects
Returns:: the communication tracking link
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

readTrackingLink

public com.crm.dataobject.communications.CRMDOCommunicationTrackingLink readTrackingLink(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                         java.lang.String url)
                                                                                  throws java.lang.Exception

Reads a communication tracking link by specifying the related communication and a url.

Parameters:: communication - - the related communication; url - - the url to load the communication tracking link
Returns:: the communication tracking link
Throws:: java.lang.Exception

readTrackingLink

public com.crm.dataobject.communications.CRMDOCommunicationTrackingLink readTrackingLink(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                         java.lang.String url,
                                                                                         java.util.ArrayList<java.lang.String> associations)
                                                                                  throws java.lang.Exception

Reads a communication tracking link by specifying the related communication and a url.

Parameters:: communication - - the related communication; url - - the url to load the communication tracking link; associations - - a list of associated data objects
Returns:: the communication tracking link
Throws:: java.lang.Exception

isAccessible
```
public java.lang.Boolean isAccessible(com.crm.dataobject.communications.CRMDOCommunicationTrackingLink communicationTrackingLink)
                               throws java.lang.Exception
```
Determines if a communication tracking link is retrievable.

Parameters:

communicationTrackingLink - - the communication tracking link to determine whether it is accessible or not

Returns:

true if the given communication tracking link is accessible, otherwise false

Throws:

java.lang.Exception

listTrackingLinks

public java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunicationTrackingLink> listTrackingLinks(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                                                        throws java.lang.Exception

Lists the tracking links of the given communication.

Parameters:: communication - - the communication to load the tracking links for
Returns:: a list of tracking links
Throws:: java.lang.Exception

listTrackingLinks

public java.util.ArrayList<com.crm.dataobject.communications.CRMDOCommunicationTrackingLink> listTrackingLinks(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                                               java.util.ArrayList<java.lang.String> associations)
                                                                                                        throws java.lang.Exception

Lists the tracking links of the given communication.

Parameters:: communication - - the communication to load the tracking links for; associations - - a list of associated data objects
Returns:: a list of tracking links
Throws:: java.lang.Exception

listRelatedEntities

public java.util.ArrayList<com.crm.framework.metadata.Entity> listRelatedEntities(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                           throws java.lang.Exception

Loads the communication related entities

Parameters:: communication - - the communication to get its related entities
Returns:: the communication related entities
Throws:: java.rmi.RemoteException; java.lang.Exception

Class CRMProcessCommunicationBean

Constructor Summary

Method Summary

Methods inherited from class com.crm.process.CRMProcess

Methods inherited from class com.crm.businessobject.CRMBase

Methods inherited from class java.lang.Object

Constructor Detail

CRMProcessCommunicationBean

Method Detail

applyCommonOperations

validateTemplate

isAccessible

initialize

newCommunication

communicateEntity

assignReferringEntity

create

update

delete

read

read

readByNumber

readByNumber

read

read

list

listFollowUpCommunications

listFollowUpCommunications

setAsViewed

followUp

replaceTags

copyAttributesFromTemplate

copyAttributesFromDefinition

copyAttributesFromDefinition

validateCompletion

complete

complete

replaceDynamicLinks

sendEmail

sendEmail

sendSMS

sendSMS

sendSMS

sendSMS

dynamicActionEmailTrack

dynamicActionLinkTrack

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications

sendCommunications