com.crm.businessobject.workflows

Class CRMBOAlertDefinitionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.workflows.CRMBOAlertDefinitionBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOAlertDefinitionBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOAlertDefinitionBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of an alert definition.
java.lang.Boolean	ifUnitExists(com.crm.dataobject.workflows.CRMDOAlertDefinition alertDefinition) Checks if an alert definition recipient-unit exists based on an alert definition.
java.lang.Boolean	ifUserExists(com.crm.dataobject.workflows.CRMDOAlertDefinition alertDefinition) Checks if an alert definition recipient-user exists based on an alert definition.
java.lang.Boolean	isUsedByWorkflowRule(com.crm.dataobject.workflows.CRMDOAlertDefinition alertDefinition, java.lang.Boolean effective) Checks if the alert definition is used by a workflow rule.
com.crm.dataobject.workflows.CRMDOAlertDefinition	loadByAltCode(java.lang.String altCode) Loads an alert definition by an alternative code.
com.crm.dataobject.workflows.CRMDOAlertDefinition	loadByAltCode(java.lang.String altCode, java.util.ArrayList<java.lang.String> associations) Loads an alert definition by an alternative code.
com.crm.dataobject.workflows.CRMDOAlertDefinition	loadByName(java.lang.String name) Loads an alert definition by a name.
com.crm.dataobject.workflows.CRMDOAlertDefinition	loadByName(java.lang.String name, java.util.ArrayList<java.lang.String> associations) Loads an alert definition by a name.
com.crm.dataobject.workflows.CRMDOAlertDefinition	setAsEffective(com.crm.dataobject.workflows.CRMDOAlertDefinition alertDefinition) Sets the life cycle state of the alert definition as effective
com.crm.dataobject.workflows.CRMDOAlertDefinition	setAsNotEffective(com.crm.dataobject.workflows.CRMDOAlertDefinition alertDefinition) Sets the life cycle state of the alert definition 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, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, 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

CRMBOAlertDefinitionBean

public CRMBOAlertDefinitionBean()

Default constructor.

Method Detail

isUsedByWorkflowRule

public java.lang.Boolean isUsedByWorkflowRule(com.crm.dataobject.workflows.CRMDOAlertDefinition alertDefinition,
                                              java.lang.Boolean effective)
                                       throws java.lang.Exception

Checks if the alert definition is used by a workflow rule.

Parameters:

alertDefinition - - the alert definition to check

effective - - a boolean to validate against effective workflow rules

Returns:

true if the alert definition is used by a workflow rule, false if not

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of an alert definition.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the alert definition

loadByName

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

Loads an alert definition by a name.

Parameters:

name - - the alert definition name

Returns:

a alert definition with the given name

Throws:

java.lang.Exception

loadByName

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

Loads an alert definition by a name.

Parameters:

name - - the alert definition name

associations - - a list of associated data objects

Returns:

an alert definition with the given name

Throws:

java.lang.Exception

loadByAltCode

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

Loads an alert definition by an alternative code.

Parameters:

altCode - - the alert definition alternative code

Returns:

an alert definition with the given alternative code

Throws:

java.lang.Exception

loadByAltCode

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

Loads an alert definition by an alternative code.

Parameters:

altCode - - the alert definition alternative code

associations - - a list of associated data objects

Returns:

an alert definition with the given alternative code

Throws:

java.lang.Exception

setAsEffective

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

Sets the life cycle state of the alert definition as effective

Parameters:

alertDefinition - - the alert definition to change its life cycle state

Returns:

the alert definition

Throws:

com.crm.exception.InvalidStateException

java.lang.Exception

com.crm.exception.CannotExecuteActionException

setAsNotEffective

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

Sets the life cycle state of the alert definition as not effective

Parameters:

alertDefinition - - the alert definition to change its life cycle state

Returns:

the alert definition

Throws:

com.crm.exception.InvalidStateException

java.lang.Exception

com.crm.exception.CannotExecuteActionException

ifUserExists

public java.lang.Boolean ifUserExists(com.crm.dataobject.workflows.CRMDOAlertDefinition alertDefinition)
                               throws java.lang.Exception

Checks if an alert definition recipient-user exists based on an alert definition.

Parameters:

alertDefinition - - the alert definition to check

Returns:

true if an alert definition recipient-user exists based on an alert definition, false if not

Throws:

java.lang.Exception

ifUnitExists

public java.lang.Boolean ifUnitExists(com.crm.dataobject.workflows.CRMDOAlertDefinition alertDefinition)
                               throws java.lang.Exception

Checks if an alert definition recipient-unit exists based on an alert definition.

Parameters:

alertDefinition - - the alert definition to check

Returns:

true if an alert definition recipient-unit exists based on an alert definition, false if not

Throws:

java.lang.Exception