com.crm.process.communicationcentre

Class CRMUICommunicationCentreBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMUI

com.crm.process.communicationcentre.CRMUICommunicationCentreBean

All Implemented Interfaces:

java.io.Serializable

public class CRMUICommunicationCentreBean
extends CRMUI

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALIAS_OPEN_CONTACT_IN_MODAL

Constructor Summary

Constructors

Constructor and Description
CRMUICommunicationCentreBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
AdvancedSearchForm	advancedSearchClear(AdvancedSearchForm advancedSearchForm) Clears and resets all the values on the advanced search form.
AdvancedSearchForm	advancedSearchFind(AdvancedSearchForm advancedSearchForm) Searches for a contact based on the advanced search criteria.
AdvancedSearchForm	constructAdvancedSearchForm() Constructs a communication centre advanced search form.
com.crm.dataobject.contactinfo.CRMDOContactInformation	createContact(CommunicationCentreForm communicationCentreForm, java.lang.Boolean isCompany) Creates a contact to add to the communication centre form.
com.crm.framework.main.LookupBuilder	getAdvancedSearchContactInformationAddressOperatorOptions() Returns the communication centre advanced search contact information address operator options.
com.crm.framework.main.LookupBuilder	getAdvancedSearchOperatorOptions() Returns the communication centre advanced search operator options.
com.crm.framework.main.LookupBuilder	getContactInfoAccountOptions(CommunicationCentreForm communicationCentreForm) Returns the contact account options.
com.crm.framework.main.LookupBuilder	getContactInfoSubscriptionOptions(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Returns the contact subscription options.
com.crm.framework.main.LookupBuilder	getSearchByOperatorOptions() Returns the communication centre search by operator options.
com.crm.framework.main.LookupBuilder	getSearchByOptions() Returns the communication centre search by options.
CommunicationCentreForm	loadAccountInformation(CommunicationCentreForm communicationCentreForm) Returns the account information.
CommunicationCentreForm	loadForm() Loads a communication centre form.
CommunicationCentreForm	loadForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Loads a communication centre form for a contact.
CommunicationCentreForm	loadForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, com.crm.dataobject.subscriptions.CRMDOSubscription subscription) Loads a communication centre form for a contact and a subscription.
CommunicationCentreForm	loadForm(java.lang.String id) Loads a communication centre form.
LatestCommunicationForm	loadLatestCommunications(java.lang.String orderBy, java.lang.Integer maxsize)
QuickPaymentForm	loadQuickPaymentForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Loads a quick payment form.
VoucherSecretNumberForm	loadRetrieveVoucherSecretNumberForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
CommunicationCentreForm	loadSubscriptionInformation(CommunicationCentreForm communicationCentreForm) Loads the subscription information of the selected subscription to the communication center form.
VoucherUseForm	loadUseVoucherForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, java.lang.String accountReceivableSelected) Loads a voucher use form.
CommunicationCentreForm	readFromSearchBy(CommunicationCentreForm communicationCentreForm, java.lang.String searchByOption, java.lang.String entityId) Loads a communication centre form based on the search option selected.
com.crm.dataobject.communications.CRMDOCommunication	returnCommunication(com.crm.dataobject.communications.CRMDOCommunication communications)
com.crm.dataobject.contactinfo.CRMDOContactInformation	returnContact(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Returns the contact to the communication centre.
CommunicationCentreForm	setAllowedActions(CommunicationCentreForm communicationCentreForm) Sets the communication centre form allowed actions.
void	setQuickPaymentAmount(QuickPaymentForm quickPaymentForm) Submits a quick payment.
void	submitQuickPaymentForm(QuickPaymentForm quickPaymentForm) Submits a quick payment.

Methods inherited from class com.crm.process.CRMUI

addAttachmentButton, addTrace, assignEntity, echoDto, echoDto, echoDto, getAccountsReceivableEntityOptions, getActiveInactiveOptions, getActiveInactiveOptions, getAssignableEntityOptions, getCurrentDate, getCurrentDay, getCurrentMonth, getCurrentYear, getDayOfWeekOptions, getDayOfWeekOptions, getDtoFromCollection, getEntityCategoryOptions, getEntityFieldOptions, getEntityOptions, getEntityStateOptions, getEntityStatusOptions, getEntityTypeOptions, getExplicitViewingAccessEntityOptions, getHourOptions, getHourOptions, getImplicitViewingAccessEntityOptions, getModuleOptions, getModulePrintoutOptions, getModuleProcessOptions, getMonthEndDate, getMonthStartDate, getOperatorOptions, getOperatorOptions, getStateOptions, getTimeOfDayOptions, getTimeOfDayOptions, getTrueFalseOptions, getTrueFalseOptions, getUnitOfTimeOptions, getUnitOfTimeOptions, getWeekEndDate, getWeekStartDate, getYesNoOptions, getYesNoOptions, invoke, load, loadAttachmentsTab, loadDaysOfMonthOptions, loadMonthNumberOptions, loadMonthNumberOptions, loadMonthOptions, loadMonthOptions, readFileContent, removeAttachmentButton, setDtoAsNotEditable, setOwnerGroup

Methods inherited from class com.crm.businessobject.CRMBase

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

Methods inherited from class java.lang.Object

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

Field Detail

ALIAS_OPEN_CONTACT_IN_MODAL

public static java.lang.String ALIAS_OPEN_CONTACT_IN_MODAL

Constructor Detail

CRMUICommunicationCentreBean

public CRMUICommunicationCentreBean()

Default constructor.

Method Detail

loadForm

public CommunicationCentreForm loadForm()
                                 throws java.lang.Exception,
                                        com.crm.exception.NoDefinitionConfiguredException

Loads a communication centre form.

Returns:

the loaded form

Throws:

java.lang.Exception

com.crm.exception.NoDefinitionConfiguredException

loadForm

public CommunicationCentreForm loadForm(java.lang.String id)
                                 throws java.lang.Exception

Loads a communication centre form.

Parameters:

id - - the communication centre id to load

Returns:

the loaded form

Throws:

java.lang.Exception

loadForm

public CommunicationCentreForm loadForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                 throws java.lang.Exception

Loads a communication centre form for a contact.

Parameters:

contactInformation - - the contact to load the communication centre form for

Returns:

the updated form

Throws:

java.lang.Exception

loadForm

public CommunicationCentreForm loadForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                               com.crm.dataobject.subscriptions.CRMDOSubscription subscription)
                                 throws java.lang.Exception

Loads a communication centre form for a contact and a subscription.

Parameters:

contactInformation - - the contact to load the communication centre form for

subscription - - the subscription to load the communication centre form for

Returns:

the updated form

Throws:

java.lang.Exception

setAllowedActions

public CommunicationCentreForm setAllowedActions(CommunicationCentreForm communicationCentreForm)
                                          throws java.lang.Exception

Sets the communication centre form allowed actions.

Parameters:

communicationCentreForm - - the communication centre form to set the allowed actions for

Returns:

the updated form

Throws:

java.lang.Exception

readFromSearchBy

public CommunicationCentreForm readFromSearchBy(CommunicationCentreForm communicationCentreForm,
                                       java.lang.String searchByOption,
                                       java.lang.String entityId)
                                         throws java.lang.Exception

Loads a communication centre form based on the search option selected.

Parameters:

communicationCentreForm - - the communication centre form to load

searchByOption - - the search by option

entityId - - the entity id to load the form for

Returns:

the updated form

Throws:

java.lang.Exception

createContact

public com.crm.dataobject.contactinfo.CRMDOContactInformation createContact(CommunicationCentreForm communicationCentreForm,
                                                                   java.lang.Boolean isCompany)
                                                                     throws java.lang.Exception

Creates a contact to add to the communication centre form.

Parameters:

communicationCentreForm - - the communication centre for to add the created contact to

isCompany - - a Boolean indicating if the contact is a company or person

Returns:

the created contact

Throws:

java.lang.Exception

getSearchByOptions

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

Returns the communication centre search by options.

Returns:

the communication centre search by options

Throws:

java.lang.Exception

getSearchByOperatorOptions

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

Returns the communication centre search by operator options.

Returns:

the communication centre search by operator options

Throws:

java.lang.Exception

getAdvancedSearchOperatorOptions

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

Returns the communication centre advanced search operator options.

Returns:

the communication centre advanced search operator options

Throws:

java.lang.Exception

getAdvancedSearchContactInformationAddressOperatorOptions

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

Returns the communication centre advanced search contact information address operator options.

Returns:

the communication centre advanced search contact information address operator options

Throws:

java.lang.Exception

constructAdvancedSearchForm

public AdvancedSearchForm constructAdvancedSearchForm()
                                               throws java.lang.Exception

Constructs a communication centre advanced search form.

Returns:

a communication centre advanced search form

Throws:

java.lang.Exception

advancedSearchFind

public AdvancedSearchForm advancedSearchFind(AdvancedSearchForm advancedSearchForm)
                                      throws java.lang.Exception,
                                             com.crm.exception.SearchResultLimitExceededException

Searches for a contact based on the advanced search criteria.

Parameters:

advancedSearchForm - - the advanced search form to search the contact from

Returns:

the updated form

Throws:

java.lang.Exception

com.crm.exception.SearchResultLimitExceededException

advancedSearchClear

public AdvancedSearchForm advancedSearchClear(AdvancedSearchForm advancedSearchForm)
                                       throws java.lang.Exception

Clears and resets all the values on the advanced search form.

Parameters:

advancedSearchForm - - the advanced search form to clear all fields for

Returns:

the updated form

Throws:

java.lang.Exception

returnContact

public com.crm.dataobject.contactinfo.CRMDOContactInformation returnContact(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                                     throws java.lang.Exception

Returns the contact to the communication centre.

Parameters:

contactInformation - - the contact to return

Returns:

the updated contact

Throws:

java.lang.Exception

loadSubscriptionInformation

public CommunicationCentreForm loadSubscriptionInformation(CommunicationCentreForm communicationCentreForm)
                                                    throws java.lang.Exception

Loads the subscription information of the selected subscription to the communication center form.

Parameters:

communicationCentreForm - - the communication centre form to load the subscription information to

Returns:

the updated form

Throws:

java.lang.Exception

getContactInfoSubscriptionOptions

public com.crm.framework.main.LookupBuilder getContactInfoSubscriptionOptions(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                                       throws java.lang.Exception

Returns the contact subscription options.

Parameters:

contactInformation - - the contact to load the subscription options for

Returns:

the contact subscription options

Throws:

java.lang.Exception

getContactInfoAccountOptions

public com.crm.framework.main.LookupBuilder getContactInfoAccountOptions(CommunicationCentreForm communicationCentreForm)
                                                                  throws java.lang.Exception

Returns the contact account options.

Parameters:

communicationCentreForm - - the communication centre form to load the account options for

Returns:

the contact account options

Throws:

java.lang.Exception

loadAccountInformation

public CommunicationCentreForm loadAccountInformation(CommunicationCentreForm communicationCentreForm)
                                               throws java.lang.Exception

Returns the account information.

Parameters:

communicationCentreForm - - the communication centre to load the account information for

Returns:

the updated form

Throws:

java.lang.Exception

loadQuickPaymentForm

public QuickPaymentForm loadQuickPaymentForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                      throws java.lang.Exception,
                                             com.crm.exception.MandatoryFieldException

Loads a quick payment form.

Parameters:

bill - - the bill to be paid

Returns:

the updated form

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

loadUseVoucherForm

public VoucherUseForm loadUseVoucherForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                java.lang.String accountReceivableSelected)
                                  throws java.lang.Exception,
                                         com.crm.exception.MandatoryFieldException

Loads a voucher use form.

Parameters:

contactInformation - - the contact to be related

accountReceivableSelected - - the related accounts receivable

Returns:

the updated form

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

loadRetrieveVoucherSecretNumberForm

public VoucherSecretNumberForm loadRetrieveVoucherSecretNumberForm(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                            throws java.lang.Exception,
                                                                   com.crm.exception.MandatoryFieldException

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

setQuickPaymentAmount

public void setQuickPaymentAmount(QuickPaymentForm quickPaymentForm)
                           throws java.lang.Exception

Submits a quick payment.

Parameters:

quickPaymentForm - - a quick payment form

Throws:

java.lang.Exception

submitQuickPaymentForm

public void submitQuickPaymentForm(QuickPaymentForm quickPaymentForm)
                            throws java.lang.Exception,
                                   com.crm.exception.MandatoryFieldException

Submits a quick payment.

Parameters:

quickPaymentForm - a quick payment form

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

returnCommunication

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

Throws:

java.lang.Exception

loadLatestCommunications

public LatestCommunicationForm loadLatestCommunications(java.lang.String orderBy,
                                               java.lang.Integer maxsize)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception