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

Class BTDataCollectionTemplateVisibilityRuleSave

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionTemplateVisibilityRuleSaveEvent>

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

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

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

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionTemplateVisibilityRuleSaveEvent.class)
public class BTDataCollectionTemplateVisibilityRuleSave
extends ValidPermissionBusinessTask<DataCollectionTemplateVisibilityRuleSaveEvent>

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

When the DataCollectionTemplateVisibilityRuleSaveEvent is launched, this task:

1. For new rules: inserts the header and all rows
2. For existing rules: updates the header, deletes old rows, and inserts new rows

Permission:

• DataCollectionPermission.FSM_DATACOLLECTION_TEMPLATE_VISIBILITY_RULES

Since:

22.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionTemplateVisibilityRuleSave()

Method Summary

Modifier and Type	Method	Description
protected void	execute(DataCollectionTemplateVisibilityRuleSaveEvent event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected Long	insertHeader(BODCTemplateVisibilityRuleHeader header, PoolKit poolKit)	Inserts the given BODCTemplateVisibilityRuleHeader and writes the newly generated id into the event journal.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected void	manageRows(Long headerId, List<BODCTemplateVisibilityRuleRow> newRows, PoolKit poolKit)	Manages the rows for the given header id.
protected List<BODCTemplateVisibilityRuleRow>	retrieveExistingRows(Long headerId, PoolKit poolKit)	Retrieves all existing rows for the given header id.
protected boolean	rowsMatch(BODCTemplateVisibilityRuleRow row1, BODCTemplateVisibilityRuleRow row2)	Checks if the two rows match.
protected void	updateHeader(BODCTemplateVisibilityRuleHeader header, PoolKit poolKit)	Updates the given BODCTemplateVisibilityRuleHeader.
protected void	validate(DataCollectionTemplateVisibilityRuleSaveInput input)	Validates the input data for the template visibility rule before saving.

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

Constructor Details

BTDataCollectionTemplateVisibilityRuleSave

public BTDataCollectionTemplateVisibilityRuleSave()

Method Details

execute

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

Description copied from class: ValidExecutionBusinessTask

Executes the actual business logic after validation has passed.

Specified by:

execute in class ValidExecutionBusinessTask<DataCollectionTemplateVisibilityRuleSaveEvent>

Parameters:

event - the input event to process

poolKit - the PoolKit

Throws:

DAException - if a data access error occurs during execution

DAValidateException - if validation fails during execution

validate

protected void validate(DataCollectionTemplateVisibilityRuleSaveInput input)

Validates the input data for the template visibility rule before saving.

Parameters:

input - the DataCollectionTemplateVisibilityRuleSaveInput to validate

insertHeader

protected Long insertHeader(BODCTemplateVisibilityRuleHeader header,
 PoolKit poolKit)
                     throws DAException,
DAValidateException

Inserts the given BODCTemplateVisibilityRuleHeader and writes the newly generated id into the event journal.

Parameters:

header - the BODCTemplateVisibilityRuleHeader to insert

poolKit - the PoolKit

Returns:

the long

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateHeader

protected void updateHeader(BODCTemplateVisibilityRuleHeader header,
 PoolKit poolKit)
                     throws DAException,
DAValidateException

Updates the given BODCTemplateVisibilityRuleHeader.

Parameters:

header - the BODCTemplateVisibilityRuleHeader to update

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

retrieveExistingRows

protected List<BODCTemplateVisibilityRuleRow> retrieveExistingRows(Long headerId,
 PoolKit poolKit)
                                                            throws DAException,
DAValidateException

Retrieves all existing rows for the given header id.

Parameters:

headerId - the header id

poolKit - the PoolKit

Returns:

the list of existing rows

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

manageRows

protected void manageRows(Long headerId,
 List<BODCTemplateVisibilityRuleRow> newRows,
 PoolKit poolKit)
                   throws DAException,
DAValidateException

Manages the rows for the given header id. Deletes existing rows that are no longer present and inserts new rows.

Parameters:

headerId - the header id

newRows - the list of new rows

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

rowsMatch

protected boolean rowsMatch(BODCTemplateVisibilityRuleRow row1,
 BODCTemplateVisibilityRuleRow row2)

Checks if the two rows match.

Parameters:

row1 - the first row

row2 - the second row

Returns:

true if the rows match, false otherwise

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