Package overit.geocallapp.wfm.mobileforms.bl.template.visibilityrules.task

Class BTDataCollectionTemplateVisibilityRuleDelete

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionTemplateVisibilityRuleDeleteEvent>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask<DataCollectionTemplateVisibilityRuleDeleteEvent>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask<DataCollectionTemplateVisibilityRuleDeleteEvent>

overit.geocallapp.wfm.mobileforms.bl.template.visibilityrules.task.BTDataCollectionTemplateVisibilityRuleDelete

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionTemplateVisibilityRuleDeleteEvent.class)
public class BTDataCollectionTemplateVisibilityRuleDelete
extends ValidPermissionBusinessTask<DataCollectionTemplateVisibilityRuleDeleteEvent>

Business task for deleting a template visibility rule with all its associated rows.

When the DataCollectionTemplateVisibilityRuleDeleteEvent is launched, this task:

1. Searches for all rows associated with the rule header
2. Deletes each row using DCTemplateVisibilityRuleRowDeleteEvent
3. Deletes the header using DCTemplateVisibilityRuleHeaderDeleteEvent

Permission:

• DataCollectionPermission.FSM_DATACOLLECTION_TEMPLATE_VISIBILITY_RULES

Since:

22.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected BODCTemplateVisibilityRuleHeader	ruleHeader

Fields inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask

LOG

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionTemplateVisibilityRuleDelete()

Method Summary

Modifier and Type	Method	Description
protected void	deleteAssociatedRows(Long ruleHeaderId, PoolKit poolKit)	Deletes all rows associated with the given rule header.
protected void	deleteHeader(Long ruleHeaderId, PoolKit poolKit)	Deletes the rule header.
protected void	execute(DataCollectionTemplateVisibilityRuleDeleteEvent event, PoolKit poolKit)	Executes the deletion of a template visibility rule with all its rows.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected List<BODCTemplateVisibilityRuleRow>	searchRows(Long ruleHeaderId, PoolKit poolKit)	Searches for all rows associated with the given rule header.
protected void	validate(Long ruleHeaderId, PoolKit poolKit)	Validates the input.

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask

checkValidExecution, getException, throwExceptionIfInvalid

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask

body, getEvent

Methods inherited from class overit.geocall.bl.BusinessTask

start, start, startAlone, startInBackground

Methods inherited from class java.lang.Object

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

Field Details

ruleHeader

protected BODCTemplateVisibilityRuleHeader ruleHeader

Constructor Details

BTDataCollectionTemplateVisibilityRuleDelete

public BTDataCollectionTemplateVisibilityRuleDelete()

Method Details

execute

protected void execute(DataCollectionTemplateVisibilityRuleDeleteEvent event,
 PoolKit poolKit)
                throws DAException,
DAValidateException

Executes the deletion of a template visibility rule with all its rows.

Specified by:

execute in class ValidExecutionBusinessTask<DataCollectionTemplateVisibilityRuleDeleteEvent>

Parameters:

event - the delete event containing the ID of the rule header to delete

poolKit - the pool kit for database operations

Throws:

DAException - if a database access error occurs

DAValidateException - if validation fails

validate

protected void validate(Long ruleHeaderId,
 PoolKit poolKit)
                 throws DAValidateException,
DAException

Validates the input.

Parameters:

ruleHeaderId - the rule header id

Throws:

DAValidateException - if validation fails

DAException

deleteAssociatedRows

protected void deleteAssociatedRows(Long ruleHeaderId,
 PoolKit poolKit)
                             throws DAException,
DAValidateException

Deletes all rows associated with the given rule header.

Parameters:

ruleHeaderId - the rule header id

poolKit - the pool kit for database operations

Throws:

DAException - if a database access error occurs

DAValidateException - if validation fails

searchRows

protected List<BODCTemplateVisibilityRuleRow> searchRows(Long ruleHeaderId,
 PoolKit poolKit)
                                                  throws DAException,
DAValidateException

Searches for all rows associated with the given rule header.

Parameters:

ruleHeaderId - the rule header id

poolKit - the pool kit for database operations

Returns:

the list of rows

Throws:

DAException - if a database access error occurs

DAValidateException

deleteHeader

protected void deleteHeader(Long ruleHeaderId,
 PoolKit poolKit)
                     throws DAException,
DAValidateException

Deletes the rule header.

Parameters:

ruleHeaderId - the rule header id

poolKit - the pool kit for database operations

Throws:

DAException - if a database access error occurs

DAValidateException - if validation fails

isValidExecution

public boolean isValidExecution()

Description copied from interface: ValidExecution

Determines whether the current state is valid for execution.

Returns:

true if execution is valid, false otherwise