com.crm.process.communications

Class CRMUICommunicationDefinitionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMUI

com.crm.process.CRMUIDefinition

com.crm.process.communications.CRMUICommunicationDefinitionBean

All Implemented Interfaces:

java.io.Serializable

public class CRMUICommunicationDefinitionBean
extends CRMUIDefinition

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMUICommunicationDefinitionBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.communications.CRMDOCommunicationDefinition	createButton() Creates a communication definition.
com.crm.dataobject.communications.CRMDOCommunicationDefinition	deleteButton(com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Deletes a communication definition.
com.crm.dataobject.communications.CRMDOCommunicationDefinition	editButton(com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Loads a communication definition form.
com.crm.dataobject.communications.CRMDOCommunicationDefinition	enableMediaSettingOnChange(com.crm.dataobject.communications.CRMDOCommunicationDefinition definition, com.crm.dataobject.communications.CommunicationMediaSetting mediaSetting)
com.crm.dataobject.communications.CRMDOCommunicationDefinition	flushButton(com.crm.dataobject.communications.CRMDOCommunicationDefinition definition)
com.crm.framework.main.LookupBuilder	getCMGatewayMethodOptions()
com.crm.framework.main.LookupBuilder	getCMGatewayMethodOptions(java.lang.String emptyValue)
com.crm.framework.main.LookupBuilder	getCMGatewayMethodURLOptions(java.lang.String value)
com.crm.framework.main.LookupBuilder	getCommunicationMediaOptions() Loads the communication media options.
com.crm.framework.main.LookupBuilder	getCommunicationMediaOptions(java.lang.String emptyValue) Loads the communication media options.
com.crm.framework.main.LookupBuilder	getEmailTrackingModeOptions() Loads the communication email tracking mode options.
com.crm.framework.main.LookupBuilder	getEmailTrackingModeOptions(java.lang.String emptyValue) Loads the communication email tracking mode options.
com.crm.framework.main.LookupBuilder	getInactiveCommunicationDefinitionOptions() Returns inactive communication definition options.
com.crm.framework.main.LookupBuilder	getInactiveCommunicationDefinitionOptions(java.lang.String emptyValue) Returns inactive communication definition options.
com.crm.framework.main.LookupBuilder	getInactiveDefinitionOptions() Loads the inactive communication definition options.
com.crm.framework.main.LookupBuilder	getInactiveDefinitionOptions(java.lang.String emptyValue) Loads the inactive communication definition options.
com.crm.framework.main.LookupBuilder	getLinkTrackingModeOptions() Loads the communication link tracking mode options.
com.crm.framework.main.LookupBuilder	getLinkTrackingModeOptions(java.lang.String emptyValue) Loads the communication link tracking mode options.
com.crm.framework.main.LookupBuilder	getNumberingPlanIndicatorOptions() Loads the numbering plan indicator options.
com.crm.framework.main.LookupBuilder	getNumberingPlanIndicatorOptions(java.lang.String emptyValue) Loads the numbering plan indicator options.
com.crm.framework.main.LookupBuilder	getNumberTypeOptions() Loads the type of number options.
com.crm.framework.main.LookupBuilder	getNumberTypeOptions(java.lang.String emptyValue) Loads the type of number options.
com.crm.framework.main.LookupBuilder	getSecurityOptions() Loads the communication definition security options.
com.crm.framework.main.LookupBuilder	getSecurityOptions(java.lang.String emptyValue) Loads the communication definition security options.
com.crm.framework.main.LookupBuilder	getSMPPCharacterEncodingOptions() Loads the SMPP character encoding options.
com.crm.framework.main.LookupBuilder	getSMPPCharacterEncodingOptions(java.lang.String emptyValue) Loads the SMPP character encoding options.
com.crm.framework.main.LookupBuilder	getSMPPMessageClassOptions() Loads the SMPP message class options.
com.crm.framework.main.LookupBuilder	getSMPPMessageClassOptions(java.lang.String emptyValue) Loads the SMPP message class options.
com.crm.framework.main.LookupBuilder	getSMSGatewayOptions()
com.crm.framework.main.LookupBuilder	getSMSGatewayOptions(java.lang.String emptyValue)
DefinitionActivationForm	loadDefinitionActivationForm(java.util.ArrayList<java.lang.Object> parameters) Creates a definition activation form.
com.crm.dataobject.communications.CRMDOCommunicationDefinition	loadForm(java.lang.String id) Loads a communication definition form.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadMediaSettingsTab(com.crm.dataobject.communications.CRMDOCommunicationDefinition definition) Loads the media settings tab
com.crm.dataobject.communications.CRMDOCommunicationDefinition	resetDynamicLinks(com.crm.dataobject.communications.CRMDOCommunicationDefinition definition, com.crm.dataobject.communications.CommunicationDefinitionDynamicLink dynamicLink) Reset dynamic links
com.crm.dataobject.communications.CommunicationDefinitionTrackingSetting	resetEmailTracking(com.crm.dataobject.communications.CommunicationDefinitionTrackingSetting trackingSetting) Reset a tracking setting
com.crm.dataobject.communications.CommunicationDefinitionTrackingSetting	resetLinkTracking(com.crm.dataobject.communications.CommunicationDefinitionTrackingSetting trackingSetting) Reset a tracking setting
com.crm.dataobject.communications.CRMDOCommunicationDefinition	resetSMSGateway(com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Resets the sms gateway
com.crm.dataobject.communications.CRMDOCommunicationDefinition	saveButton(com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition) Saves a communication definition.
com.crm.dataobject.communications.CRMDOCommunicationDefinition	setMandatoryFields(com.crm.dataobject.communications.CRMDOCommunicationDefinition definition)
DefinitionActivationForm	submitDefinitionActivationButton(DefinitionActivationForm definitionActivationForm) Activates a definition.
void	testConnectionButton(com.crm.dataobject.CRMDO dto) Test the connection defined in communication definition.

Methods inherited from class com.crm.process.CRMUI

addAttachmentButton, addExistingAttachmentButton, addExistingAttachmentsButton, addTrace, assignEntity, echoDto, echoDto, echoDto, echoDtos, getAccountsReceivableEntityOptions, getActiveInactiveOptions, getActiveInactiveOptions, getAllowedDeniedOptions, getAllowedDeniedOptions, getApplicationOptions, getArchiveDataEntityOptions, getArchiveDataEntityOptions, getArchiveEntityOptions, getArchiveEntityOptions, getAssignableEntityOptions, getCurrentDateString, getCurrentDay, getCurrentMonth, getCurrentYear, getDayOfWeekOptions, getDayOfWeekOptions, getDtoFromCollection, getEntityCategoryOptions, getEntityFieldOptions, getEntityOptions, getEntityStateOptions, getEntityStatusOptions, getEntityTypeOptions, getExplicitViewingAccessEntityOptions, getHourOptions, getHourOptions, getImplicitViewingAccessEntityOptions, getModuleOptions, getModulePrintoutOptions, getModuleProcessOptions, getMonthEndDate, getMonthStartDate, getOperatorOptions, getOperatorOptions, getStateOptions, getStringFormattingOptions, getStringFormattingOptions, getTimeOfDayOptions, getTimeOfDayOptions, getTrueFalseOptions, getTrueFalseOptions, getUnitOfTimeOptions, getUnitOfTimeOptions, getWeekEndDate, getWeekStartDate, getYesNoOptions, getYesNoOptions, invoke, load, loadAchivedData, loadAttachmentsTab, loadDaysOfMonthOptions, loadDaysOfMonthOptions, loadEntityAttributeTranslations, loadMonthNumberOptions, loadMonthNumberOptions, loadMonthOptions, loadMonthOptions, readFileContent, removeAttachmentButton, setDefaultLanguage, setDtoAsNotEditable, setDtoAsNotModified, setLanguageTranslations, setMandatoryField, setMandatoryFields, setOwnerGroup

Methods inherited from class com.crm.businessobject.CRMBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CRMUICommunicationDefinitionBean

public CRMUICommunicationDefinitionBean()

Default constructor.

Method Detail

loadForm

public com.crm.dataobject.communications.CRMDOCommunicationDefinition loadForm(java.lang.String id)
                                                                        throws java.lang.Exception

Loads a communication definition form.

Parameters:

id - - the communication definition id to load

Returns:

the loaded form

Throws:

java.lang.Exception

flushButton

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

Throws:

java.lang.Exception

createButton

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

Creates a communication definition.

Returns:

a communication definition.

Throws:

java.lang.Exception

saveButton

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

Saves a communication definition.

Parameters:

communicationDefinition - - the communication definition to save

Returns:

the saved communication definition

Throws:

java.lang.Exception

editButton

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

Loads a communication definition form.

Parameters:

communicationDefinition - - the communication definition to load

Returns:

the loaded form

Throws:

java.lang.Exception

deleteButton

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

Deletes a communication definition.

Parameters:

communicationDefinition - - the communication definition to delete

Returns:

the deleted communication definition

Throws:

java.lang.Exception

submitDefinitionActivationButton

public DefinitionActivationForm submitDefinitionActivationButton(DefinitionActivationForm definitionActivationForm)
                                                          throws java.lang.Exception

Activates a definition.

Specified by:

submitDefinitionActivationButton in class CRMUIDefinition

Parameters:

definitionActivationForm - - the definition activation form to activate

Returns:

the updated form

Throws:

java.lang.Exception

loadDefinitionActivationForm

public DefinitionActivationForm loadDefinitionActivationForm(java.util.ArrayList<java.lang.Object> parameters)
                                                      throws java.lang.Exception

Creates a definition activation form.

Specified by:

loadDefinitionActivationForm in class CRMUIDefinition

Parameters:

parameters - - a list of object parameters

Returns:

the created definition form

Throws:

java.lang.Exception

getInactiveCommunicationDefinitionOptions

public com.crm.framework.main.LookupBuilder getInactiveCommunicationDefinitionOptions()
                                                                               throws java.lang.Exception

Returns inactive communication definition options.

Returns:

the inactive communication definition options

Throws:

java.lang.Exception

getInactiveCommunicationDefinitionOptions

public com.crm.framework.main.LookupBuilder getInactiveCommunicationDefinitionOptions(java.lang.String emptyValue)
                                                                               throws java.lang.Exception

Returns inactive communication definition options.

Parameters:

emptyValue - - an empty value for an inactive communication definition

Returns:

the inactive communication definition options

Throws:

java.lang.Exception

getInactiveDefinitionOptions

public com.crm.framework.main.LookupBuilder getInactiveDefinitionOptions()
                                                                  throws java.lang.Exception

Loads the inactive communication definition options.

Returns:

the inactive communication definition options

Throws:

java.lang.Exception

getInactiveDefinitionOptions

public com.crm.framework.main.LookupBuilder getInactiveDefinitionOptions(java.lang.String emptyValue)
                                                                  throws java.lang.Exception

Loads the inactive communication definition options.

Parameters:

emptyValue - - an empty value for a communication definition

Returns:

the inactive communication definition options

Throws:

java.lang.Exception

getSecurityOptions

public com.crm.framework.main.LookupBuilder getSecurityOptions()
                                                        throws java.lang.Exception

Loads the communication definition security options.

Returns:

the communication definition security options

Throws:

java.lang.Exception

getSecurityOptions

public com.crm.framework.main.LookupBuilder getSecurityOptions(java.lang.String emptyValue)
                                                        throws java.lang.Exception

Loads the communication definition security options.

Parameters:

emptyValue - - an empty value for a communication definition

Returns:

the communication definition security options

Throws:

java.lang.Exception

testConnectionButton

public void testConnectionButton(com.crm.dataobject.CRMDO dto)
                          throws java.lang.Exception

Test the connection defined in communication definition.

Parameters:

dto - - the communication definition to test

Throws:

java.lang.Exception

getSMSGatewayOptions

public com.crm.framework.main.LookupBuilder getSMSGatewayOptions()
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getSMSGatewayOptions

public com.crm.framework.main.LookupBuilder getSMSGatewayOptions(java.lang.String emptyValue)
                                                          throws java.lang.Exception

Throws:

java.lang.Exception

getCMGatewayMethodOptions

public com.crm.framework.main.LookupBuilder getCMGatewayMethodOptions()
                                                               throws java.lang.Exception

Throws:

java.lang.Exception

getCMGatewayMethodOptions

public com.crm.framework.main.LookupBuilder getCMGatewayMethodOptions(java.lang.String emptyValue)
                                                               throws java.lang.Exception

Throws:

java.lang.Exception

getCMGatewayMethodURLOptions

public com.crm.framework.main.LookupBuilder getCMGatewayMethodURLOptions(java.lang.String value)
                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

loadMediaSettingsTab

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadMediaSettingsTab(com.crm.dataobject.communications.CRMDOCommunicationDefinition definition)
                                                                   throws java.lang.Exception

Loads the media settings tab

Parameters:

definition - - the communication definition to load the media settings for

Returns:

a list of media settings

Throws:

java.lang.Exception

getCommunicationMediaOptions

public com.crm.framework.main.LookupBuilder getCommunicationMediaOptions()
                                                                  throws java.lang.Exception

Loads the communication media options.

Returns:

the communication media options

Throws:

java.lang.Exception

getCommunicationMediaOptions

public com.crm.framework.main.LookupBuilder getCommunicationMediaOptions(java.lang.String emptyValue)
                                                                  throws java.lang.Exception

Loads the communication media options.

Parameters:

emptyValue - - an empty value for a communication media

Returns:

the communication media

Throws:

java.lang.Exception

enableMediaSettingOnChange

public com.crm.dataobject.communications.CRMDOCommunicationDefinition enableMediaSettingOnChange(com.crm.dataobject.communications.CRMDOCommunicationDefinition definition,
                                                                                                 com.crm.dataobject.communications.CommunicationMediaSetting mediaSetting)

setMandatoryFields

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

Throws:

java.lang.Exception

getEmailTrackingModeOptions

public com.crm.framework.main.LookupBuilder getEmailTrackingModeOptions()
                                                                 throws java.lang.Exception

Loads the communication email tracking mode options.

Returns:

the communication email tracking mode options

Throws:

java.lang.Exception

getEmailTrackingModeOptions

public com.crm.framework.main.LookupBuilder getEmailTrackingModeOptions(java.lang.String emptyValue)
                                                                 throws java.lang.Exception

Loads the communication email tracking mode options.

Parameters:

emptyValue - - an empty value for a communication email tracking mode

Returns:

the communication email tracking mode options

Throws:

java.lang.Exception

getLinkTrackingModeOptions

public com.crm.framework.main.LookupBuilder getLinkTrackingModeOptions()
                                                                throws java.lang.Exception

Loads the communication link tracking mode options.

Returns:

the communication link tracking mode options

Throws:

java.lang.Exception

getLinkTrackingModeOptions

public com.crm.framework.main.LookupBuilder getLinkTrackingModeOptions(java.lang.String emptyValue)
                                                                throws java.lang.Exception

Loads the communication link tracking mode options.

Parameters:

emptyValue - - an empty value for a communication link tracking mode

Returns:

the communication link tracking mode options

Throws:

java.lang.Exception

resetEmailTracking

public com.crm.dataobject.communications.CommunicationDefinitionTrackingSetting resetEmailTracking(com.crm.dataobject.communications.CommunicationDefinitionTrackingSetting trackingSetting)
                                                                                            throws java.lang.Exception

Reset a tracking setting

Parameters:

trackingSetting - - the communication definition tracking setting to reset

Returns:

the updated communication definition tracking setting

Throws:

java.lang.Exception

resetLinkTracking

public com.crm.dataobject.communications.CommunicationDefinitionTrackingSetting resetLinkTracking(com.crm.dataobject.communications.CommunicationDefinitionTrackingSetting trackingSetting)
                                                                                           throws java.lang.Exception

Reset a tracking setting

Parameters:

trackingSetting - - the communication definition tracking setting to reset

Returns:

the updated communication definition tracking setting

Throws:

java.lang.Exception

resetDynamicLinks

public com.crm.dataobject.communications.CRMDOCommunicationDefinition resetDynamicLinks(com.crm.dataobject.communications.CRMDOCommunicationDefinition definition,
                                                                                        com.crm.dataobject.communications.CommunicationDefinitionDynamicLink dynamicLink)
                                                                                 throws java.lang.Exception

Reset dynamic links

Parameters:

definition - - the communication definition to update

dynamicLink - - the communication definition dynamic link to reset

Returns:

the updated communication definition

Throws:

java.lang.Exception

resetSMSGateway

public com.crm.dataobject.communications.CRMDOCommunicationDefinition resetSMSGateway(com.crm.dataobject.communications.CRMDOCommunicationDefinition communicationDefinition)

Resets the sms gateway

Parameters:

communicationDefinition - - the communication definition to reset the sms gateway for

Returns:

the updated communication definition

getSMPPCharacterEncodingOptions

public com.crm.framework.main.LookupBuilder getSMPPCharacterEncodingOptions()
                                                                     throws java.lang.Exception

Loads the SMPP character encoding options.

Returns:

the SMPP character encoding options

Throws:

java.lang.Exception

getSMPPCharacterEncodingOptions

public com.crm.framework.main.LookupBuilder getSMPPCharacterEncodingOptions(java.lang.String emptyValue)
                                                                     throws java.lang.Exception

Loads the SMPP character encoding options.

Parameters:

emptyValue - - an empty value for a SMPP character encoding

Returns:

the SMPP character encoding options

Throws:

java.lang.Exception

getNumberTypeOptions

public com.crm.framework.main.LookupBuilder getNumberTypeOptions()
                                                          throws java.lang.Exception

Loads the type of number options.

Returns:

the type of number options

Throws:

java.lang.Exception

getNumberTypeOptions

public com.crm.framework.main.LookupBuilder getNumberTypeOptions(java.lang.String emptyValue)
                                                          throws java.lang.Exception

Loads the type of number options.

Parameters:

emptyValue - - an empty value for a type of number

Returns:

the type of number options

Throws:

java.lang.Exception

getNumberingPlanIndicatorOptions

public com.crm.framework.main.LookupBuilder getNumberingPlanIndicatorOptions()
                                                                      throws java.lang.Exception

Loads the numbering plan indicator options.

Returns:

the numbering plan indicator options

Throws:

java.lang.Exception

getNumberingPlanIndicatorOptions

public com.crm.framework.main.LookupBuilder getNumberingPlanIndicatorOptions(java.lang.String emptyValue)
                                                                      throws java.lang.Exception

Loads the numbering plan indicator options.

Parameters:

emptyValue - - an empty value for a numbering plan indicator

Returns:

the numbering plan indicator options

Throws:

java.lang.Exception

getSMPPMessageClassOptions

public com.crm.framework.main.LookupBuilder getSMPPMessageClassOptions()
                                                                throws java.lang.Exception

Loads the SMPP message class options.

Returns:

the SMPP message class options

Throws:

java.lang.Exception

getSMPPMessageClassOptions

public com.crm.framework.main.LookupBuilder getSMPPMessageClassOptions(java.lang.String emptyValue)
                                                                throws java.lang.Exception

Loads the SMPP message class options.

Parameters:

emptyValue - - an empty value for a SMPP character encoding

Returns:

the SMPP message class options

Throws:

java.lang.Exception