com.crm.process.leads

Class CRMProcessLeadBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMProcess

com.crm.process.leads.CRMProcessLeadBean

All Implemented Interfaces:

java.io.Serializable

public class CRMProcessLeadBean
extends CRMProcess

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMProcessLeadBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	anonymizeContactLeads(com.crm.dataobject.contactinfo.CRMDOContactInformation contact) Anonymizes the given contact information leads
com.crm.dataobject.leads.CRMDOLead	assignAccountReceivable(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Assigns an account receivable on a lead.
com.crm.dataobject.leads.CRMDOLead	cancel(com.crm.dataobject.leads.CRMDOLead lead)
com.crm.dataobject.leads.CRMDOLead	cancel(com.crm.dataobject.leads.CRMDOLead lead, com.crm.dataobject.leads.CRMDOLeadStatus status) Cancels a lead.
com.crm.dataobject.leads.CRMDOLead	complete(com.crm.dataobject.leads.CRMDOLead lead) Completes a lead.
com.crm.dataobject.accounts.CRMDOAccountReceivable	constructAccountReceivable(com.crm.dataobject.leads.CRMDOLead lead)
com.crm.dataobject.leads.CRMDOLead	create(com.crm.dataobject.leads.CRMDOLead lead) Creates a lead.
com.crm.dataobject.leads.CRMDOLead	delete(com.crm.dataobject.leads.CRMDOLead lead) Deletes a lead.
void	importLead(com.crm.dataobject.leads.CRMDOLead lead, com.crm.dataobject.CRMDOAttachment attachment, com.crm.dataobject.leads.ImportLeadDefinition importLeadDefinition, com.crm.dataobject.processrun.CRMDOProcessRunLog processRun)
java.lang.Boolean	isAccessible(com.crm.dataobject.leads.CRMDOLead lead) Determine if a lead is accessible.
java.util.ArrayList<com.crm.dataobject.leads.CRMDOLead>	list(com.crm.dataobject.leads.LeadSearchCriteria searchCriteria) Loads a list of accessible leads that match the given criteria.
com.crm.dataobject.leads.CRMDOLead	lost(com.crm.dataobject.leads.CRMDOLead lead, com.crm.dataobject.leads.CRMDOLeadLostReason lostReason)
com.crm.dataobject.leads.CRMDOLead	lost(com.crm.dataobject.leads.CRMDOLead lead, com.crm.dataobject.leads.CRMDOLeadStatus status, com.crm.dataobject.leads.CRMDOLeadLostReason lostReason) Sets a lead as Lost.
com.crm.dataobject.leads.CRMDOLead	newLead(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable) Constructs and initializes a new AttachmentClassification.
com.crm.dataobject.leads.CRMDOLead	preProcessToWin(com.crm.dataobject.leads.CRMDOLead lead) Pre-processes a lead to win.
com.crm.dataobject.leads.CRMDOLead	read(java.lang.String uniqueIdentifier) Reads a attachment by id.
com.crm.dataobject.leads.CRMDOLead	read(java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations) Reads a attachment by id.
com.crm.dataobject.leads.CRMDOLead	read(java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations, java.lang.Boolean initializeAssociatedObjects) Reads a attachment by id.
com.crm.dataobject.leads.CRMDOLead	startProgress(com.crm.dataobject.leads.CRMDOLead lead)
com.crm.dataobject.leads.CRMDOLead	startProgress(com.crm.dataobject.leads.CRMDOLead lead, com.crm.dataobject.leads.CRMDOLeadStatus status) Starts the progress of the given lead.
com.crm.dataobject.leads.CRMDOLead	update(com.crm.dataobject.leads.CRMDOLead lead) Updates a lead.
com.crm.dataobject.leads.CRMDOLead	validateCancellation(com.crm.dataobject.leads.CRMDOLead lead, com.crm.dataobject.leads.CRMDOLeadStatus status)
com.crm.dataobject.leads.CRMDOLead	win(com.crm.dataobject.leads.CRMDOLead lead)
com.crm.dataobject.leads.CRMDOLead	win(com.crm.dataobject.leads.CRMDOLead lead, com.crm.dataobject.leads.CRMDOLeadStatus status) Sets a lead as Won.

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

CRMProcessLeadBean

public CRMProcessLeadBean()

Default constructor.

Method Detail

complete

public com.crm.dataobject.leads.CRMDOLead complete(com.crm.dataobject.leads.CRMDOLead lead)
                                            throws java.lang.Exception

Completes a lead. Sets the lead's actual completed date and the source Validates the lead Validates that the lead can be completed Saves the lead

Parameters:

lead - - the lead to complete

Returns:

the completed lead

Throws:

java.lang.Exception

create

public com.crm.dataobject.leads.CRMDOLead create(com.crm.dataobject.leads.CRMDOLead lead)
                                          throws java.lang.Exception

Creates a lead. Sets the lead's source Validates and saves the lead

Parameters:

lead - - the lead to create

Returns:

the created lead

Throws:

java.lang.Exception

update

public com.crm.dataobject.leads.CRMDOLead update(com.crm.dataobject.leads.CRMDOLead lead)
                                          throws java.lang.Exception,
                                                 com.crm.exception.leads.CannotModifyLeadAlreadyCompletedException

Updates a lead. Validates the lead's life cycle state Sets the lead's source values Validates and saves the lead Sends communications if the lead status is changed

Parameters:

lead - - the lead to update

Returns:

the updated lead

Throws:

java.lang.Exception

com.crm.exception.leads.CannotModifyLeadAlreadyCompletedException

constructAccountReceivable

public com.crm.dataobject.accounts.CRMDOAccountReceivable constructAccountReceivable(com.crm.dataobject.leads.CRMDOLead lead)
                                                                              throws java.lang.Exception

Throws:

java.lang.Exception

assignAccountReceivable

public com.crm.dataobject.leads.CRMDOLead assignAccountReceivable(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                           throws java.lang.Exception

Assigns an account receivable on a lead.

Parameters:

accountReceivable - - the account receivable to assign

Returns:

the updated lead

Throws:

java.lang.Exception

preProcessToWin

public com.crm.dataobject.leads.CRMDOLead preProcessToWin(com.crm.dataobject.leads.CRMDOLead lead)
                                                   throws java.lang.Exception

Pre-processes a lead to win. If the lead does not have an account receivable and the auto creation of a lead's account is configured in the active lead definition, creates an account receivable for the lead

Parameters:

lead - - the lead to pre-process

Returns:

the updated lead

Throws:

java.lang.Exception

startProgress

public com.crm.dataobject.leads.CRMDOLead startProgress(com.crm.dataobject.leads.CRMDOLead lead)
                                                 throws java.lang.Exception,
                                                        com.crm.exception.leads.CannotModifyLeadAlreadyCompletedException

Throws:

java.lang.Exception

com.crm.exception.leads.CannotModifyLeadAlreadyCompletedException

startProgress

public com.crm.dataobject.leads.CRMDOLead startProgress(com.crm.dataobject.leads.CRMDOLead lead,
                                                        com.crm.dataobject.leads.CRMDOLeadStatus status)
                                                 throws java.lang.Exception

Starts the progress of the given lead. Validates that the lead's progress can start Sets the lead life cycle state and status Validates and saves the lead

Parameters:

lead - - the lead to start the progress of

status - - the status to set on the lead

Returns:

the updated lead

Throws:

java.lang.Exception

cancel

public com.crm.dataobject.leads.CRMDOLead cancel(com.crm.dataobject.leads.CRMDOLead lead)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

cancel

public com.crm.dataobject.leads.CRMDOLead cancel(com.crm.dataobject.leads.CRMDOLead lead,
                                                 com.crm.dataobject.leads.CRMDOLeadStatus status)
                                          throws java.lang.Exception

Cancels a lead. Validates that the lead can be cancelled Validates the lead Sets the given status on the lead Sets the lead life cycle state Saves the lead

Parameters:

lead - - the lead to cancel

status - - the status to set on the cancelled lead

Returns:

the cancelled lead

Throws:

java.lang.Exception

validateCancellation

public com.crm.dataobject.leads.CRMDOLead validateCancellation(com.crm.dataobject.leads.CRMDOLead lead,
                                                               com.crm.dataobject.leads.CRMDOLeadStatus status)
                                                        throws java.lang.Exception,
                                                               com.crm.exception.leads.CannotModifyLeadAlreadyCompletedException

Throws:

java.lang.Exception

com.crm.exception.leads.CannotModifyLeadAlreadyCompletedException

win

public com.crm.dataobject.leads.CRMDOLead win(com.crm.dataobject.leads.CRMDOLead lead)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

win

public com.crm.dataobject.leads.CRMDOLead win(com.crm.dataobject.leads.CRMDOLead lead,
                                              com.crm.dataobject.leads.CRMDOLeadStatus status)
                                       throws java.lang.Exception

Sets a lead as Won. Validates that the lead can be set as Won Validates the lead If the lead has a modified account, saves the lead's account and sets the account's contact information as the lead's contact information Sets the lead's status and life cycle state Saves the lead

Parameters:

lead - - the lead to set as Won

status - - the status to set on the lead

Returns:

the won lead

Throws:

java.lang.Exception

lost

public com.crm.dataobject.leads.CRMDOLead lost(com.crm.dataobject.leads.CRMDOLead lead,
                                               com.crm.dataobject.leads.CRMDOLeadLostReason lostReason)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

lost

public com.crm.dataobject.leads.CRMDOLead lost(com.crm.dataobject.leads.CRMDOLead lead,
                                               com.crm.dataobject.leads.CRMDOLeadStatus status,
                                               com.crm.dataobject.leads.CRMDOLeadLostReason lostReason)
                                        throws java.lang.Exception

Sets a lead as Lost. Validates that the lead can be set as lost Validates the lead Sets the status, the life cycle state and the lost reason on the lead Saves the lead If the lead has a new or modified account receivable, validates and saves its account

Parameters:

lead - - the lead to set as Lost

status - - the status to set on the lead

lostReason - - the reason the lead was lost

Returns:

the lost lead

Throws:

java.lang.Exception

importLead

public void importLead(com.crm.dataobject.leads.CRMDOLead lead,
                       com.crm.dataobject.CRMDOAttachment attachment,
                       com.crm.dataobject.leads.ImportLeadDefinition importLeadDefinition,
                       com.crm.dataobject.processrun.CRMDOProcessRunLog processRun)
                throws java.lang.Exception

Throws:

java.lang.Exception

anonymizeContactLeads

public void anonymizeContactLeads(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)
                           throws java.lang.Exception

Anonymizes the given contact information leads

Parameters:

contact - - the contact information to anonymize its leads

Throws:

java.lang.Exception

list

public java.util.ArrayList<com.crm.dataobject.leads.CRMDOLead> list(com.crm.dataobject.leads.LeadSearchCriteria searchCriteria)
                                                             throws java.lang.Exception

Loads a list of accessible leads that match the given criteria.

Parameters:

searchCriteria - - the criteria

Returns:

a list of leads

Throws:

java.lang.Exception

isAccessible

public java.lang.Boolean isAccessible(com.crm.dataobject.leads.CRMDOLead lead)
                               throws java.lang.Exception

Determine if a lead is accessible.

Parameters:

lead - - the lead to check if it is accessible

Returns:

true, if it is accessible, else false

Throws:

java.lang.Exception

read

public com.crm.dataobject.leads.CRMDOLead read(java.lang.String uniqueIdentifier)
                                        throws java.lang.Exception

Reads a attachment by id.

Parameters:

uniqueIdentifier - - the attachment unique identifier(mandatory)

Returns:

the attachment

Throws:

java.lang.Exception

read

public com.crm.dataobject.leads.CRMDOLead read(java.lang.String uniqueIdentifier,
                                               java.util.ArrayList<java.lang.String> associations)
                                        throws java.lang.Exception,
                                               com.crm.exception.CannotAccessEntityException

Reads a attachment by id.

Parameters:

uniqueIdentifier - - the attachment unique identifier(mandatory)

associations - - a list of associations(optional)

Returns:

the attachment

Throws:

java.lang.Exception

com.crm.exception.CannotAccessEntityException

read

public com.crm.dataobject.leads.CRMDOLead read(java.lang.String uniqueIdentifier,
                                               java.util.ArrayList<java.lang.String> associations,
                                               java.lang.Boolean initializeAssociatedObjects)
                                        throws java.lang.Exception,
                                               com.crm.exception.CannotAccessEntityException

Reads a attachment by id.

Parameters:

uniqueIdentifier - - the attachment unique identifier(mandatory)

associations - - a list of associations(optional)

initializeAssociatedObjects - - a boolean indicating if the associated objects will be initialized(optional)

Returns:

the attachment

Throws:

java.lang.Exception

com.crm.exception.CannotAccessEntityException

delete

public com.crm.dataobject.leads.CRMDOLead delete(com.crm.dataobject.leads.CRMDOLead lead)
                                          throws java.lang.Exception,
                                                 com.crm.exception.CannotAccessEntityException

Deletes a lead.

Parameters:

lead - - the lead to delete(mandatory)

Returns:

the deleted lead

Throws:

java.lang.Exception

com.crm.exception.CannotAccessEntityException

newLead

public com.crm.dataobject.leads.CRMDOLead newLead(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                           throws java.lang.Exception

Constructs and initializes a new AttachmentClassification.

Returns:

the attachmentClassification

Throws:

java.lang.Exception