Package overit.geocallapp.wfm.mobileforms.bl.instance.task

Class BTDataCollectionSheetInstanceRequestUnlock

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionSheetInstanceRequestUnlockEvent>

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

overit.geocallapp.wfm.mobileforms.bl.task.BTDataCollection<DataCollectionSheetInstanceRequestUnlockEvent>

overit.geocallapp.wfm.mobileforms.bl.instance.task.BTDataCollectionSheetInstanceRequestUnlock

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionSheetInstanceRequestUnlockEvent.class)
public class BTDataCollectionSheetInstanceRequestUnlock
extends BTDataCollection<DataCollectionSheetInstanceRequestUnlockEvent>

Business task for requesting to unlock a data collection sheet.

This task processes DataCollectionSheetInstanceRequestUnlockEvent events and sets the unlock request flag to true after validating that the sheet meets all requirements for unlocking.

The request unlock workflow involves:

1. Validating the sheet meets unlock requirements (via DataCollectionSheetInstanceUnlockingRequestCheckEvent)
2. Loading the sheet from the database
3. Setting the unlock request flag to true
4. Updating the sheet in the database

Since:

22.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionSheetInstanceRequestUnlock()

Method Summary

Modifier and Type	Method	Description
protected void	checkSheet(Long sheetId, PoolKit poolKit)	Validates that the sheet meets all requirements for requesting unlock.
protected void	execute(DataCollectionSheetInstanceRequestUnlockEvent event, PoolKit poolKit)	Executes the request unlock workflow.
protected void	launchUpdateEvent(BODataCollectionSheet sheet, PoolKit poolKit)
protected BODataCollectionSheet	loadSheet(Long sheetId, PoolKit poolKit)	Loads a data collection sheet by its ID.
protected void	updateSheet(Long sheetId, PoolKit poolKit)	Updates the sheet by setting the unlock request flag to true.

Methods inherited from class overit.geocallapp.wfm.mobileforms.bl.task.BTDataCollection

getException, isValidExecution, throwExceptionIfInvalid

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

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

BTDataCollectionSheetInstanceRequestUnlock

public BTDataCollectionSheetInstanceRequestUnlock()

Method Details

execute

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

Executes the request unlock workflow.

Specified by:

execute in class ValidExecutionBusinessTask<DataCollectionSheetInstanceRequestUnlockEvent>

Parameters:

event - the request unlock event containing the sheet ID

poolKit - the database connection pool kit for database operations

Throws:

DAException - if a database error occurs

DAValidateException - if the sheet ID is null or validation fails

checkSheet

protected void checkSheet(Long sheetId,
 PoolKit poolKit)
                   throws DAException,
DAValidateException

Validates that the sheet meets all requirements for requesting unlock.

Parameters:

sheetId - the unique identifier of the sheet to validate

poolKit - the database connection pool kit for database operations

Throws:

DAException - if a database error occurs during validation

DAValidateException - if the sheet does not meet unlock requirements

updateSheet

protected void updateSheet(Long sheetId,
 PoolKit poolKit)
                    throws DAException,
DAValidateException

Updates the sheet by setting the unlock request flag to true.

Parameters:

sheetId - the unique identifier of the sheet to update

poolKit - the database connection pool kit for database operations

Throws:

DAException - if a database error occurs during update

DAValidateException - if validation fails during update

launchUpdateEvent

protected void launchUpdateEvent(BODataCollectionSheet sheet,
 PoolKit poolKit)
                          throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

loadSheet

protected BODataCollectionSheet loadSheet(Long sheetId,
 PoolKit poolKit)
                                   throws DAValidateException,
DAException

Loads a data collection sheet by its ID.

Parameters:

sheetId - the unique identifier of the sheet to load

poolKit - the database connection pool kit for database operations

Returns:

the loaded data collection sheet

Throws:

DAValidateException - if the sheet ID is invalid or sheet not found

DAException - if a database error occurs during loading