com.crm.businessobject.processrun

Class CRMBOProcessRunDefinitionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.processrun.CRMBOProcessRunDefinitionBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOProcessRunDefinitionBean
extends CRMBO

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CRMBOProcessRunDefinitionBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a process run definition.
java.lang.String	getExceptionKeyByProcessName(java.lang.String process)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.notifications.CRMDONotificationType notificationType, java.util.ArrayList<java.lang.String> associations)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState, java.util.Date asOfDate, java.lang.Boolean onlyTheLatestVersion) Loads a list of process run definitions.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState, java.util.Date asOfDate, java.lang.Boolean onlyTheLatestVersion, java.lang.String process, java.lang.String module, java.lang.String orderBy, java.lang.Integer maxSize) Loads a list of process run definitions.
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	load(java.lang.String id) Loads a process run definition by an ID.
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	load(java.lang.String id, java.util.ArrayList<java.lang.String> associations) Loads a process run definition by an ID.
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	load(java.lang.String process, java.lang.String module) Loads a process run definition given a list of criteria
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	load(java.lang.String module, java.lang.String process, java.util.ArrayList<java.lang.String> associations) Loads a process run definition given a list of criteria
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String process, java.lang.String module, com.crm.dataobject.processrun.CRMDOProcessRunDefinition excludedProcessRunDefinition, java.util.ArrayList<java.lang.String> associations) Loads a list of process run definitions.
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	load(java.lang.String module, java.lang.String process, com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a process run definition given a list of criteria
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	load(java.lang.String module, java.lang.String process, java.lang.String name, com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState) Loads a process run definition given a list of criteria
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	load(java.lang.String module, java.lang.String process, java.lang.String name, com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations) Loads a process run definition given a list of criteria
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadAdditionalInformation(com.crm.dataobject.processrun.CRMDOProcessRunDefinition definition)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAllEffective(java.lang.String module, java.lang.String process, java.util.ArrayList<java.lang.String> associations) Loads all the effective process run definitions based on the given criteria, order in a descending order by the date they were created and their version
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadByAltCode(java.lang.String altCode) Loads a process run definition by an alternative code.
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadByAltCode(java.lang.String altCode, java.util.ArrayList<java.lang.String> associations) Loads a process run definition by an alternative code.
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadByName(java.lang.String name) Loads a process run definition by a name.
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadByName(java.lang.String name, java.util.ArrayList<java.lang.String> associations) Loads a process run definition by a name.
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadByProcess(java.lang.String process)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadEffective()
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadEffective(java.lang.String process, java.lang.String module, java.util.ArrayList<java.lang.String> associations) Loads an effective process run definition given a list of criteria
com.crm.dataobject.paymentgateway.PaymentGatewayProcessRunDefinition	loadEffective(java.lang.String module, java.lang.String process, com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting, java.util.ArrayList<java.lang.String> associations) Loads an effective payment gateway process run definition given a list of criteria
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadLatest(java.lang.String unifiedCode)
com.crm.dataobject.processrun.CRMDOProcessRunDefinition	loadLatestEffective(java.lang.String process, java.lang.String module, java.util.ArrayList<java.lang.String> associations) Loads the latest effective process run definition given a list of criteria
com.crm.framework.metadata.Process	submit(com.crm.dataobject.processrun.CRMDOProcessRunDefinition processRunDefinition)
com.crm.framework.metadata.Process	submit(com.crm.dataobject.processrun.CRMDOProcessRunLog processRunLog)
com.crm.framework.metadata.Process	submit(com.crm.dataobject.processrun.CRMDOProcessRunLog processRunLog, java.lang.String type, com.crm.process.utilities.SchedulerTask schedulerTask)
void	validateMandatoryFields(com.crm.process.utilities.SchedulerTask schedulerTask)
void	validateMandatoryFields(com.crm.process.utilities.SchedulerTask schedulerTask, com.crm.dataobject.processrun.CRMDOProcessRunDefinition processRunDefinition)

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

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

Methods inherited from class java.lang.Object

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

Field Detail

ALIAS_SET_AS_NOT_EFFECTIVE

public static java.lang.String ALIAS_SET_AS_NOT_EFFECTIVE

Constructor Detail

CRMBOProcessRunDefinitionBean

public CRMBOProcessRunDefinitionBean()

Default constructor.

Method Detail

validateMandatoryFields

public void validateMandatoryFields(com.crm.process.utilities.SchedulerTask schedulerTask)
                             throws java.lang.Exception

Throws:

java.lang.Exception

validateMandatoryFields

public void validateMandatoryFields(com.crm.process.utilities.SchedulerTask schedulerTask,
                                    com.crm.dataobject.processrun.CRMDOProcessRunDefinition processRunDefinition)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a process run definition.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the process run definition

loadEffective

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

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState,
                                                          java.util.Date asOfDate,
                                                          java.lang.Boolean onlyTheLatestVersion)
                                                   throws java.lang.Exception

Loads a list of process run definitions.

Parameters:

lifeCycleState - the life cycle state to load the process run definitions for

asOfDate - The batch process has at least one run that was created on a date which is equal or after the specified as of date

onlyTheLatestVersion - when true the only the latest version of the process run definition will retrieve

Returns:

a list effective process run definitions

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState,
                                                          java.util.Date asOfDate,
                                                          java.lang.Boolean onlyTheLatestVersion,
                                                          java.lang.String process,
                                                          java.lang.String module,
                                                          java.lang.String orderBy,
                                                          java.lang.Integer maxSize)
                                                   throws java.lang.Exception

Loads a list of process run definitions.

Parameters:

lifeCycleState - - the life cycle state to load the process run definitions for

asOfDate - - the batch process has at least one run that was created on a date which is equal or after the specified as of date

onlyTheLatestVersion - - when true the only the latest version of the process run definition will retrieve

process - - the process name of the process run definition that will be retrieved

module - - the module name of the process run definition that will be retrieved

orderBy - - the order by clause

maxSize - - the maximum number of process run definitions to retrieve

Returns:

a list effective process run definitions

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.notifications.CRMDONotificationType notificationType,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

loadLatest

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition loadLatest(java.lang.String unifiedCode)
                                                                   throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                          java.lang.Exception

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

loadByProcess

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition loadByProcess(java.lang.String process)
                                                                      throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                             java.lang.Exception

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

loadAdditionalInformation

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition loadAdditionalInformation(com.crm.dataobject.processrun.CRMDOProcessRunDefinition definition)
                                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

submit

public com.crm.framework.metadata.Process submit(com.crm.dataobject.processrun.CRMDOProcessRunLog processRunLog)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

submit

public com.crm.framework.metadata.Process submit(com.crm.dataobject.processrun.CRMDOProcessRunLog processRunLog,
                                                 java.lang.String type,
                                                 com.crm.process.utilities.SchedulerTask schedulerTask)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

submit

public com.crm.framework.metadata.Process submit(com.crm.dataobject.processrun.CRMDOProcessRunDefinition processRunDefinition)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

load

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition load(java.lang.String process,
                                                                    java.lang.String module)
                                                             throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                    java.lang.Exception

Loads a process run definition given a list of criteria

Parameters:

process - - the process to load the process run definition for

module - - the module to load the process run definition for

Returns:

a process run definition data object

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

loadLatestEffective

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition loadLatestEffective(java.lang.String process,
                                                                                   java.lang.String module,
                                                                                   java.util.ArrayList<java.lang.String> associations)
                                                                            throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                                   java.lang.Exception

Loads the latest effective process run definition given a list of criteria

Parameters:

module - - the module to load the process run definition for

process - - the process to load the process run definition for

associations - - a list of associated objects to be initialised

Returns:

a process run definition data object

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

loadEffective

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition loadEffective(java.lang.String process,
                                                                             java.lang.String module,
                                                                             java.util.ArrayList<java.lang.String> associations)
                                                                      throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                             java.lang.Exception

Loads an effective process run definition given a list of criteria

Parameters:

module - - the module to load the process run definition for

process - - the process to load the process run definition for

associations - - a list of associated objects to be initialised

Returns:

a process run definition data object

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

load

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition load(java.lang.String module,
                                                                    java.lang.String process,
                                                                    java.util.ArrayList<java.lang.String> associations)
                                                             throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                    java.lang.Exception

Loads a process run definition given a list of criteria

Parameters:

module - - the module to load the process run definition for

process - - the process to load the process run definition for

associations - - a list of associated objects to be initialised

Returns:

a process run definition data object

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

loadAllEffective

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadAllEffective(java.lang.String module,
                                                                      java.lang.String process,
                                                                      java.util.ArrayList<java.lang.String> associations)
                                                               throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                      java.lang.Exception

Loads all the effective process run definitions based on the given criteria, order in a descending order by the date they were created and their version

Parameters:

module - - the module to load the process run definition for

process - - the process to load the process run definition for

associations - - the list of associated object to initialise

Returns:

a list of effective process run definitions

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

load

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition load(java.lang.String module,
                                                                    java.lang.String process,
                                                                    com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState,
                                                                    java.util.ArrayList<java.lang.String> associations)
                                                             throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                    java.lang.Exception

Loads a process run definition given a list of criteria

Parameters:

module - - the module to load the process run definition for

process - - the process to load the process run definition for

lifeCycleState - - the life cycle state of the loaded process run definition

associations - - a list of associated objects to be initialised

Returns:

a process run definition data object

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

load

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition load(java.lang.String module,
                                                                    java.lang.String process,
                                                                    java.lang.String name,
                                                                    com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState)
                                                             throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                    java.lang.Exception

Loads a process run definition given a list of criteria

Parameters:

module - - the module to load the process run definition for

process - - the process to load the process run definition for

name - - the name to load the process run definition for

lifeCycleState - - the life cycle state of the loaded process run definition

Returns:

a process run definition data object

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

load

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition load(java.lang.String module,
                                                                    java.lang.String process,
                                                                    java.lang.String name,
                                                                    com.crm.dataobject.processrun.ProcessRunDefinitionLifeCycleState lifeCycleState,
                                                                    java.util.ArrayList<java.lang.String> associations)
                                                             throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                    java.lang.Exception

Loads a process run definition given a list of criteria

Parameters:

module - - the module to load the process run definition for

process - - the process to load the process run definition for

name - - the name to load the process run definition for

lifeCycleState - - the life cycle state of the loaded process run definition

associations - - a list of associated objects to be initialised

Returns:

a process run definition data object

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

loadEffective

public com.crm.dataobject.paymentgateway.PaymentGatewayProcessRunDefinition loadEffective(java.lang.String module,
                                                                                          java.lang.String process,
                                                                                          com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting,
                                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                                   throws com.crm.exception.businessnetwork.CannotViewRecordException,
                                                                                          java.lang.Exception

Loads an effective payment gateway process run definition given a list of criteria

Parameters:

module - - the module to load the payment gateway process run definition for

process - - the process to load the payment gateway process run definition for

paymentGatewaySetting - - the payment gateway setting to load the payment gateway process run definition for

associations - - a list of associated objects to be initialised

Returns:

a payment gateway process run definition data object

Throws:

com.crm.exception.businessnetwork.CannotViewRecordException

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(java.lang.String process,
                                                          java.lang.String module,
                                                          com.crm.dataobject.processrun.CRMDOProcessRunDefinition excludedProcessRunDefinition,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of process run definitions.

Parameters:

process - - the process name of the process run definition that will be retrieved

module - - the module name of the process run definition that will be retrieved

excludedProcessRunDefinition - - the process run definition to exclude from the returned list of objects

Returns:

a list of process run definitions

Throws:

java.lang.Exception

load

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition load(java.lang.String id)
                                                             throws java.lang.Exception

Loads a process run definition by an ID.

Overrides:

load in class CRMBO

Parameters:

id - - the process run definition ID

Returns:

a process run definition with the specified name

Throws:

java.lang.Exception

load

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition load(java.lang.String id,
                                                                    java.util.ArrayList<java.lang.String> associations)
                                                             throws java.lang.Exception

Loads a process run definition by an ID.

Overrides:

load in class CRMBO

Parameters:

id - - the process run definition ID

associations - - a list of associated data objects

Returns:

a process run definition with the specified name

Throws:

java.lang.Exception

loadByName

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition loadByName(java.lang.String name)
                                                                   throws java.lang.Exception

Loads a process run definition by a name.

Parameters:

name - - the process run definition name

Returns:

a process run definition with the specified name

Throws:

java.lang.Exception

loadByName

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

Loads a process run definition by a name.

Parameters:

name - - the process run definition name

associations - - a list of associated data objects

Returns:

a process run definition with the specified name

Throws:

java.lang.Exception

loadByAltCode

public com.crm.dataobject.processrun.CRMDOProcessRunDefinition loadByAltCode(java.lang.String altCode)
                                                                      throws java.lang.Exception

Loads a process run definition by an alternative code.

Parameters:

altCode - - the process run definition alternative code

Returns:

a process run definition with the given alternative code

Throws:

java.lang.Exception

loadByAltCode

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

Loads a process run definition by an alternative code.

Parameters:

altCode - - the process run definition alternative code

associations - - a list of associated data objects

Returns:

a process run definition with the given alternative code

Throws:

java.lang.Exception

getExceptionKeyByProcessName

public java.lang.String getExceptionKeyByProcessName(java.lang.String process)