com.crm.businessobject.communications

Class CRMBOCommunicationTemplateBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOConfigurationEntity

com.crm.businessobject.communications.CRMBOCommunicationTemplateBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOCommunicationTemplateBean
extends CRMBOConfigurationEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOCommunicationTemplateBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a communication template.
java.lang.Boolean	isUsedByJobDefinition(com.crm.dataobject.communications.CRMDOCommunicationTemplate communicationTemplate) Checks if the communication template is used by a job definition.
java.lang.Boolean	isUsedByNotificationType(com.crm.dataobject.communications.CRMDOCommunicationTemplate communicationTemplate) Checks if the communication template is used by a notification type.
java.lang.Boolean	isUsedByServiceRequestDefinition(com.crm.dataobject.communications.CRMDOCommunicationTemplate communicationTemplate) Checks if the communication template is used by a service request definition.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.communications.CommunicationMedia communicationMedia) Loads a list of communication templates based on communication media and life cycle state.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.communications.CRMDOCommunicationCategory communicationCategory, com.crm.dataobject.communications.CommunicationTemplateLifeCycleState lifeCycleState, java.util.ArrayList<com.crm.framework.metadata.Entity> relatedEntities) Loads a list of communication templates based on communication category and life cycle state.
com.crm.dataobject.communications.CRMDOCommunicationTemplate	loadByAltCode(java.lang.String altCode) Loads a communication template by an alternative code.
com.crm.dataobject.communications.CRMDOCommunicationTemplate	loadByAltCode(java.lang.String altCode, java.util.ArrayList<java.lang.String> associations) Loads a communication template by an alternative code.
com.crm.dataobject.communications.CRMDOCommunicationTemplate	loadByName(java.lang.String name) Loads a communication template by a name.
com.crm.dataobject.communications.CRMDOCommunicationTemplate	loadByName(java.lang.String name, java.util.ArrayList<java.lang.String> associations) Loads a communication template by a name.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffective(com.crm.dataobject.communications.CRMDOCommunicationCategory communicationCategory) Loads a list of effective communication templates based on communication category.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadRelatedEffective(java.util.ArrayList<com.crm.framework.metadata.Entity> relatedEntities) Loads a list of effective communication templates based on communication category.

Methods inherited from class com.crm.businessobject.CRMBOConfigurationEntity

isDefault, loadDefault, setDefault

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CRMBOCommunicationTemplateBean

public CRMBOCommunicationTemplateBean()

Default constructor.

Method Detail

isUsedByNotificationType

public java.lang.Boolean isUsedByNotificationType(com.crm.dataobject.communications.CRMDOCommunicationTemplate communicationTemplate)
                                           throws java.lang.Exception

Checks if the communication template is used by a notification type.

Parameters:

communicationTemplate - - the communication template to check

Returns:

true if the communication template is used by a notification type, false if not

Throws:

java.lang.Exception

isUsedByServiceRequestDefinition

public java.lang.Boolean isUsedByServiceRequestDefinition(com.crm.dataobject.communications.CRMDOCommunicationTemplate communicationTemplate)
                                                   throws java.lang.Exception

Checks if the communication template is used by a service request definition.

Parameters:

communicationTemplate - - the communication template to check

Returns:

true if the communication template is used by a service request definition, false if not

Throws:

java.lang.Exception

isUsedByJobDefinition

public java.lang.Boolean isUsedByJobDefinition(com.crm.dataobject.communications.CRMDOCommunicationTemplate communicationTemplate)
                                        throws java.lang.Exception

Checks if the communication template is used by a job definition.

Parameters:

communicationTemplate - - the communication template to check

Returns:

true if the communication template is used by a job definition, false if not

Throws:

java.lang.Exception

getDefaultAssociations

public java.util.ArrayList<java.lang.String> getDefaultAssociations()

Returns the default associated data objects of a communication template.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the communication template

loadByName

public com.crm.dataobject.communications.CRMDOCommunicationTemplate loadByName(java.lang.String name)
                                                                        throws java.lang.Exception

Loads a communication template by a name.

Parameters:

name - - the communication template

Returns:

a communication template with the given name

Throws:

java.lang.Exception

loadByName

public com.crm.dataobject.communications.CRMDOCommunicationTemplate loadByName(java.lang.String name,
                                                                      java.util.ArrayList<java.lang.String> associations)
                                                                        throws java.lang.Exception

Loads a communication template by a name.

Parameters:

name - - the communication template name

associations - - a list of associated data objects

Returns:

a communication template with the given name

Throws:

java.lang.Exception

loadByAltCode

public com.crm.dataobject.communications.CRMDOCommunicationTemplate loadByAltCode(java.lang.String altCode)
                                                                           throws java.lang.Exception

Loads a communication template by an alternative code.

Parameters:

altCode - - the communication template alternative code

Returns:

a communication template with the given alternative code

Throws:

java.lang.Exception

loadByAltCode

public com.crm.dataobject.communications.CRMDOCommunicationTemplate loadByAltCode(java.lang.String altCode,
                                                                         java.util.ArrayList<java.lang.String> associations)
                                                                           throws java.lang.Exception

Loads a communication template by an alternative code.

Parameters:

altCode - - the communication template alternative code

associations - - a list of associated data objects

Returns:

a communication template with the given alternative code

Throws:

java.lang.Exception

loadEffective

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadEffective(com.crm.dataobject.communications.CRMDOCommunicationCategory communicationCategory)
                                                            throws java.lang.Exception

Loads a list of effective communication templates based on communication category.

Parameters:

communicationCategory - - the communication category related to communication templates

Returns:

a list of effective communication templates based on communication category

Throws:

java.lang.Exception

loadRelatedEffective

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadRelatedEffective(java.util.ArrayList<com.crm.framework.metadata.Entity> relatedEntities)
                                                                   throws java.lang.Exception

Loads a list of effective communication templates based on communication category.

Parameters:

communicationCategory - - the communication category related to communication templates

Returns:

a list of effective communication templates based on communication category

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.communications.CRMDOCommunicationCategory communicationCategory,
                                                 com.crm.dataobject.communications.CommunicationTemplateLifeCycleState lifeCycleState,
                                                 java.util.ArrayList<com.crm.framework.metadata.Entity> relatedEntities)
                                                   throws java.lang.Exception

Loads a list of communication templates based on communication category and life cycle state.

Parameters:

communicationCategory - - the communication category related to communication templates

lifeCycleState - - the life cycle state related to communication templates

Returns:

a list of effective communication templates based on communication category

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.communications.CommunicationMedia communicationMedia)
                                                   throws java.lang.Exception

Loads a list of communication templates based on communication media and life cycle state.

Parameters:

communicationMedia - - the communication media related to communication templates

Returns:

a list of effective communication templates based on communication media

Throws:

java.lang.Exception