com.crm.businessobject.workflows

Class CRMBOWebhookDefinitionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.workflows.CRMBOWebhookDefinitionBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOWebhookDefinitionBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOWebhookDefinitionBean() 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 webhook definition.
java.lang.Boolean	isUsedByWorkflowRule(com.crm.dataobject.workflows.CRMDOWebhookDefinition webhookDefinition, java.lang.Boolean effective) Checks if the webhook definition is used by a workflow rule.
com.crm.dataobject.workflows.CRMDOWebhookDefinition	loadByAltCode(java.lang.String altCode) Loads a webhook definition by an alternative code.
com.crm.dataobject.workflows.CRMDOWebhookDefinition	loadByAltCode(java.lang.String altCode, java.util.ArrayList<java.lang.String> associations) Loads a webhook definition by an alternative code.
com.crm.dataobject.workflows.CRMDOWebhookDefinition	loadByName(java.lang.String name) Loads a webhook definition by a name.
com.crm.dataobject.workflows.CRMDOWebhookDefinition	loadByName(java.lang.String name, java.util.ArrayList<java.lang.String> associations) Loads a webhook definition by a name.
com.crm.dataobject.workflows.CRMDOWebhookDefinition	setAsEffective(com.crm.dataobject.workflows.CRMDOWebhookDefinition webhookDefinition) Sets the life cycle state of the webhook definition as effective
com.crm.dataobject.workflows.CRMDOWebhookDefinition	setAsNotEffective(com.crm.dataobject.workflows.CRMDOWebhookDefinition webhookDefinition) Sets the life cycle state of the webhook definition as 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

CRMBOWebhookDefinitionBean

public CRMBOWebhookDefinitionBean()

Default constructor.

Method Detail

isUsedByWorkflowRule

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

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

Parameters:

webhookDefinition - - the webhook definition to check

effective - - a boolean to validate against effective workflow rules

Returns:

true if the webhook 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 a webhook definition.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the webhook definition

loadByName

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

Loads a webhook definition by a name.

Parameters:

name - - the webhook definition name

Returns:

a webhook definition with the given name

Throws:

java.lang.Exception

loadByName

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

Loads a webhook definition by a name.

Parameters:

name - - the webhook definition name

associations - - a list of associated data objects

Returns:

a webhook definition with the given name

Throws:

java.lang.Exception

loadByAltCode

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

Loads a webhook definition by an alternative code.

Parameters:

altCode - - the webhook definition alternative code

Returns:

a webhook definition with the given alternative code

Throws:

java.lang.Exception

loadByAltCode

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

Loads a webhook definition by an alternative code.

Parameters:

altCode - - the webhook definition alternative code

associations - - a list of associated data objects

Returns:

a webhook definition with the given alternative code

Throws:

java.lang.Exception

setAsEffective

public com.crm.dataobject.workflows.CRMDOWebhookDefinition setAsEffective(com.crm.dataobject.workflows.CRMDOWebhookDefinition webhookDefinition)
                                                                   throws com.crm.exception.InvalidStateException,
                                                                          java.lang.Exception

Sets the life cycle state of the webhook definition as effective

Parameters:

webhookDefinition - - the webhook definition to change its life cycle state

Returns:

the webhook definition

Throws:

com.crm.exception.InvalidStateException

java.lang.Exception

setAsNotEffective

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

Sets the life cycle state of the webhook definition as effective

Parameters:

webhookDefinition - - the webhook definition to change its life cycle state

Returns:

the webhook definition

Throws:

com.crm.exception.InvalidStateException

java.lang.Exception

com.crm.exception.CannotExecuteActionException