com.crm.businessobject.workflows

Class CRMBOWorkflowRuleBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.workflows.CRMBOWorkflowRuleBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOWorkflowRuleBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOWorkflowRuleBean() 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 workflow rule.
java.lang.Boolean	isEntityTypeExists(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule, java.lang.String entityTypePKID) Checks if a workflow rule entity type exists.
java.lang.Boolean	isJobTypeBasedOnOrderedItemsExist(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule) Checks if a workflow rule entity type exists with job type's fulfilment scope set to Based On Ordered Items.
java.lang.Boolean	isNotEffectiveDefinitionExists(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule) Checks if the workflow rule uses not effective definitions in actions.
java.lang.Boolean	isValid(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule, com.crm.dataobject.CRMDO entityDO, com.crm.framework.metadata.Entity entity)
java.util.ArrayList<com.crm.dataobject.workflows.CRMDOWorkflowRule>	load(java.lang.String orderBy, java.lang.Integer numberOfResults, java.lang.Integer offset, com.crm.dataobject.workflows.WorkflowRuleLifeCycleState lifeCycleState, java.lang.String entityID, com.crm.dataobject.CRMDO entityType, java.lang.Boolean triggerOnCreate, java.lang.Boolean triggerOnUpdate, java.lang.Boolean triggerViaAPI, java.util.Date createdDate, java.util.ArrayList<java.lang.String> defaultAssociations) Loads a list of workflow rules based on given parameters.
java.util.ArrayList<com.crm.dataobject.workflows.CRMDOWorkflowRule>	load(com.crm.dataobject.workflows.WorkflowRuleLifeCycleState lifeCycleState, java.lang.String entityID, com.crm.dataobject.CRMDO entityType, java.lang.Boolean triggerOnCreate, java.lang.Boolean triggerOnUpdate, java.lang.Boolean triggerViaAPI, java.util.ArrayList<java.lang.String> defaultAssociations) Loads a list of workflow rules based on given parameters.
java.util.ArrayList<com.crm.dataobject.workflows.CRMDOWorkflowRule>	load(com.crm.dataobject.workflows.WorkflowRuleLifeCycleState lifeCycleState, java.lang.String entityID, com.crm.dataobject.CRMDO entityType, java.lang.Boolean triggerOnCreate, java.lang.Boolean triggerOnUpdate, java.lang.Boolean triggerViaAPI, java.util.Date createdDate, java.util.ArrayList<java.lang.String> defaultAssociations) Loads a list of workflow rules based on given parameters.
com.crm.dataobject.workflows.CRMDOWorkflowRule	loadByAltCode(java.lang.String altCode) Loads a workflow rule by an alternative code.
com.crm.dataobject.workflows.CRMDOWorkflowRule	loadByAltCode(java.lang.String altCode, java.util.ArrayList<java.lang.String> associations) Loads a workflow rule by an alternative code.
com.crm.dataobject.workflows.CRMDOWorkflowRule	loadByName(java.lang.String name) Loads a workflow rule by a name.
com.crm.dataobject.workflows.CRMDOWorkflowRule	loadByName(java.lang.String name, java.util.ArrayList<java.lang.String> associations) Loads a workflow rule by a name.
com.crm.dataobject.workflows.CRMDOWorkflowRule	setAsEffective(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule) Sets the life cycle state of the workflow rule as effective
com.crm.dataobject.workflows.CRMDOWorkflowRule	setAsNotEffective(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule) Sets the life cycle state of the workflow rule as not effective

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, 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

Constructor Detail

CRMBOWorkflowRuleBean

public CRMBOWorkflowRuleBean()

Default constructor.

Method Detail

getDefaultAssociations

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

Returns the default associated data objects of a workflow rule.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the workflow rule

loadByName

public com.crm.dataobject.workflows.CRMDOWorkflowRule loadByName(java.lang.String name)
                                                          throws java.lang.Exception

Loads a workflow rule by a name.

Parameters:

name - - the workflow rule name

Returns:

a workflow rule with the given name

Throws:

java.lang.Exception

loadByName

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

Loads a workflow rule by a name.

Parameters:

name - - the workflow rule name

associations - - a list of associated data objects

Returns:

a workflow rule with the given name

Throws:

java.lang.Exception

loadByAltCode

public com.crm.dataobject.workflows.CRMDOWorkflowRule loadByAltCode(java.lang.String altCode)
                                                             throws java.lang.Exception

Loads a workflow rule by an alternative code.

Parameters:

altCode - - the workflow rule alternative code

Returns:

a workflow rule with the given alternative code

Throws:

java.lang.Exception

loadByAltCode

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

Loads a workflow rule by an alternative code.

Parameters:

altCode - - the workflow rule alternative code

associations - - a list of associated data objects

Returns:

a workflow rule with the given alternative code

Throws:

java.lang.Exception

setAsEffective

public com.crm.dataobject.workflows.CRMDOWorkflowRule setAsEffective(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule)
                                                              throws com.crm.exception.InvalidStateException,
                                                                     java.lang.Exception,
                                                                     com.crm.exception.CannotExecuteActionException

Sets the life cycle state of the workflow rule as effective

Parameters:

workflowRule - - the workflow rule to change its life cycle state

Returns:

the workflow rule

Throws:

com.crm.exception.InvalidStateException

java.lang.Exception

com.crm.exception.CannotExecuteActionException

setAsNotEffective

public com.crm.dataobject.workflows.CRMDOWorkflowRule setAsNotEffective(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule)
                                                                 throws com.crm.exception.InvalidStateException,
                                                                        java.lang.Exception,
                                                                        com.crm.exception.CannotExecuteActionException

Sets the life cycle state of the workflow rule as not effective

Parameters:

workflowRule - - the workflow rule to change its life cycle state

Returns:

the workflow rule

Throws:

com.crm.exception.InvalidStateException

java.lang.Exception

com.crm.exception.CannotExecuteActionException

isNotEffectiveDefinitionExists

public java.lang.Boolean isNotEffectiveDefinitionExists(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule)
                                                 throws java.lang.Exception

Checks if the workflow rule uses not effective definitions in actions.

Parameters:

workflowRule - - the workflow rule to check

Returns:

true if the workflow rule uses not effective definitions in actions, false if not

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.workflows.CRMDOWorkflowRule> load(com.crm.dataobject.workflows.WorkflowRuleLifeCycleState lifeCycleState,
                                                                                java.lang.String entityID,
                                                                                com.crm.dataobject.CRMDO entityType,
                                                                                java.lang.Boolean triggerOnCreate,
                                                                                java.lang.Boolean triggerOnUpdate,
                                                                                java.lang.Boolean triggerViaAPI,
                                                                                java.util.ArrayList<java.lang.String> defaultAssociations)
                                                                         throws java.lang.Exception

Loads a list of workflow rules based on given parameters.

Parameters:

lifeCycleState -

entityID -

triggerOnCreate -

triggerOnUpdate -

triggerViaAPI -

defaultAssociations -

Returns:

a list of workflow rules based on given parameters

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.workflows.CRMDOWorkflowRule> load(com.crm.dataobject.workflows.WorkflowRuleLifeCycleState lifeCycleState,
                                                                                java.lang.String entityID,
                                                                                com.crm.dataobject.CRMDO entityType,
                                                                                java.lang.Boolean triggerOnCreate,
                                                                                java.lang.Boolean triggerOnUpdate,
                                                                                java.lang.Boolean triggerViaAPI,
                                                                                java.util.Date createdDate,
                                                                                java.util.ArrayList<java.lang.String> defaultAssociations)
                                                                         throws java.lang.Exception

Loads a list of workflow rules based on given parameters.

Parameters:

lifeCycleState -

entityID -

triggerOnCreate -

triggerOnUpdate -

triggerViaAPI -

createdDate -

defaultAssociations -

Returns:

a list of workflow rules based on given parameters

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.workflows.CRMDOWorkflowRule> load(java.lang.String orderBy,
                                                                                java.lang.Integer numberOfResults,
                                                                                java.lang.Integer offset,
                                                                                com.crm.dataobject.workflows.WorkflowRuleLifeCycleState lifeCycleState,
                                                                                java.lang.String entityID,
                                                                                com.crm.dataobject.CRMDO entityType,
                                                                                java.lang.Boolean triggerOnCreate,
                                                                                java.lang.Boolean triggerOnUpdate,
                                                                                java.lang.Boolean triggerViaAPI,
                                                                                java.util.Date createdDate,
                                                                                java.util.ArrayList<java.lang.String> defaultAssociations)
                                                                         throws java.lang.Exception

Loads a list of workflow rules based on given parameters.

Parameters:

numberOfResults -

orderBy -

offset -

lifeCycleState -

entityID -

triggerOnCreate -

triggerOnUpdate -

triggerViaAPI -

createdDate -

defaultAssociations -

Returns:

a list of workflow rules based on given parameters

Throws:

java.lang.Exception

isValid

public java.lang.Boolean isValid(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule,
                                 com.crm.dataobject.CRMDO entityDO,
                                 com.crm.framework.metadata.Entity entity)
                          throws java.lang.Exception

Parameters:

workflowRule - - the workflow rule to validate

entityDO - - the related entity

entity -

Returns:

true or false

Throws:

java.lang.Exception

isEntityTypeExists

public java.lang.Boolean isEntityTypeExists(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule,
                                            java.lang.String entityTypePKID)
                                     throws java.lang.Exception

Checks if a workflow rule entity type exists.

Parameters:

workflowRule - - the workflow rule to check

entityTypePKID - - the entity type parent key ID to check

Returns:

true if the workflow rule entity type exists, false if not

Throws:

java.lang.Exception

isJobTypeBasedOnOrderedItemsExist

public java.lang.Boolean isJobTypeBasedOnOrderedItemsExist(com.crm.dataobject.workflows.CRMDOWorkflowRule workflowRule)
                                                    throws java.lang.Exception

Checks if a workflow rule entity type exists with job type's fulfilment scope set to Based On Ordered Items.

Parameters:

workflowRule - - the workflow rule to check

Returns:

true if the workflow rule entity type exists, false if not

Throws:

java.lang.Exception