com.crm.businessobject.jobs

Class CRMBOJobDefinitionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOConfigurationEntity

com.crm.businessobject.CRMBODefinition

com.crm.businessobject.jobs.CRMBOJobDefinitionBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOJobDefinitionBean
extends CRMBODefinition

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOJobDefinitionBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.crm.dataobject.communications.CRMDOCommunication	copyFromCommunicationAttributesDefinition(com.crm.dataobject.jobs.CRMDOJobDefinition jobDefinition, com.crm.dataobject.communications.CRMDOCommunication communication, com.crm.dataobject.jobs.JobCommunicationState communicationState, com.crm.dataobject.jobs.JobTypeFulfillmentScope jobTypeFulfillmentScope) Copies communication attributes from job definition into a communication.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a job definition.
boolean	isAllowed(com.crm.dataobject.jobs.CRMDOJobCancelReason jobCancelReason) Checks if a job cancel reason is allowed based on the active job definition.
boolean	isAllowed(com.crm.dataobject.jobs.CRMDOJobType jobType) Checks if a job type is allowed based on the active job definition.
boolean	isEnabled(com.crm.dataobject.jobs.CRMDOJobDefinition jobDefinition, com.crm.dataobject.jobs.JobCommunicationState communicationState) Checks if a job's definition communication setting is enabled.
com.crm.dataobject.jobs.CRMDOJobDefinition	loadAdditionalInformation(com.crm.dataobject.jobs.CRMDOJobDefinition jobDefinition) Loads additional information of a job definition.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllowedCancellationReasons(com.crm.dataobject.jobs.CRMDOJobDefinition jobDefinition) Returns the allowed job cancellation reasons of the active job definition.
java.util.ArrayList<com.crm.dataobject.CRMDO>	setActiveDefinition(com.crm.dataobject.CRMDODefinition definition) Sets a job definition as active.

Methods inherited from class com.crm.businessobject.CRMBODefinition

loadActiveDefinition, loadInactiveDefinitions, save, validateOnDelete

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, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, 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

CRMBOJobDefinitionBean

public CRMBOJobDefinitionBean()

Default constructor.

Method Detail

setActiveDefinition

public java.util.ArrayList<com.crm.dataobject.CRMDO> setActiveDefinition(com.crm.dataobject.CRMDODefinition definition)
                                                                  throws java.lang.Exception

Sets a job definition as active.

Overrides:

setActiveDefinition in class CRMBODefinition

Parameters:

definition - - the job definition to set as active

Returns:

a list of job definitions

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

getDefaultAssociations

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

Returns the default associated data objects of a job definition.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the job definition

loadAdditionalInformation

public com.crm.dataobject.jobs.CRMDOJobDefinition loadAdditionalInformation(com.crm.dataobject.jobs.CRMDOJobDefinition jobDefinition)
                                                                     throws java.lang.Exception

Loads additional information of a job definition.

Parameters:

jobDefinition - - job definition to load the additional information for

Returns:

the updated job definition

Throws:

java.lang.Exception

isAllowed

public boolean isAllowed(com.crm.dataobject.jobs.CRMDOJobType jobType)
                  throws java.lang.Exception

Checks if a job type is allowed based on the active job definition.

Parameters:

jobType - - the job type to check

Returns:

true if the job type is allowed based on the active job definition, false if not

Throws:

java.lang.Exception

isAllowed

public boolean isAllowed(com.crm.dataobject.jobs.CRMDOJobCancelReason jobCancelReason)
                  throws java.lang.Exception

Checks if a job cancel reason is allowed based on the active job definition.

Parameters:

jobCancelReason - - the job cancel reason to check

Returns:

true if the job cancel reason is allowed based on the active job definition, false if not

Throws:

java.lang.Exception

loadAllowedCancellationReasons

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllowedCancellationReasons(com.crm.dataobject.jobs.CRMDOJobDefinition jobDefinition)
                                                                             throws java.lang.Exception

Returns the allowed job cancellation reasons of the active job definition.

Returns:

the allowed job cancellation reasons of the active job definition

Throws:

java.lang.Exception

isEnabled

public boolean isEnabled(com.crm.dataobject.jobs.CRMDOJobDefinition jobDefinition,
                com.crm.dataobject.jobs.JobCommunicationState communicationState)

Checks if a job's definition communication setting is enabled.

Parameters:

jobDefinition - - the job definition to check

communicationState - - the communication state of the communication setting

Returns:

a job definition.

Throws:

java.lang.Exception

copyFromCommunicationAttributesDefinition

public com.crm.dataobject.communications.CRMDOCommunication copyFromCommunicationAttributesDefinition(com.crm.dataobject.jobs.CRMDOJobDefinition jobDefinition,
                                                                                             com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                                             com.crm.dataobject.jobs.JobCommunicationState communicationState,
                                                                                             com.crm.dataobject.jobs.JobTypeFulfillmentScope jobTypeFulfillmentScope)
                                                                                               throws java.lang.Exception

Copies communication attributes from job definition into a communication.

Parameters:

jobDefinition - - the job definition to copy the information from

communication - - the communication to copy the template attributes

Returns:

the communication with the copied communication template attributes

Throws:

java.lang.Exception