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

Class BTDataCollectionSheetInstanceUnlock

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionSheetInstanceUnlockEvent>

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

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

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

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionSheetInstanceUnlockEvent.class)
public class BTDataCollectionSheetInstanceUnlock
extends BTDataCollection<DataCollectionSheetInstanceUnlockEvent>

Business task for unlocking data collection sheet instances.

This task handles the unlocking (fixing) of data collection sheets that have been requested for unlocking. It processes DataCollectionSheetInstanceUnlockEvent events and performs comprehensive validation before fixing the sheet and resetting its unlock status.

Since:

22.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionSheetInstanceUnlock()

Method Summary

Modifier and Type	Method	Description
protected void	checkSheet(Long sheetId, PoolKit poolKit)	Validates that the sheet meets all requirements for unlocking.
protected void	execute(DataCollectionSheetInstanceUnlockEvent event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected void	fixSheet(Long sheetId, PoolKit poolKit)	Fixes the sheet by launching a fix event.
boolean	isValidExecution()	Determines whether this task can be executed based on user permissions.
protected BODataCollectionSheet	loadSheet(Long sheetId, PoolKit poolKit)	Loads a data collection sheet by its ID.
protected void	resetUnlockSheet(Long sheetId, PoolKit poolKit)	Resets the unlock request flag on the sheet to false.
protected void	sendPushNotification(Long sheetId, PoolKit poolKit)	Sends a push notification to the user about the sheet unlock.

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

getException, 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

BTDataCollectionSheetInstanceUnlock

public BTDataCollectionSheetInstanceUnlock()

Method Details

execute

protected void execute(DataCollectionSheetInstanceUnlockEvent 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<DataCollectionSheetInstanceUnlockEvent>

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

checkSheet

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

Validates that the sheet meets all requirements for unlocking. Launches an unlock check event and throws an exception if validation fails.

Parameters:

sheetId - the id of the data collection sheet to validate

poolKit - the database connection pool kit for database operations

Throws:

DAValidateException - if the sheet fails validation checks

DAException - if a database error occurs during validation

fixSheet

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

Fixes the sheet by launching a fix event.

Parameters:

sheetId - the ID of the sheet to fix

poolKit - the database connection pool kit for database operations

Throws:

DAValidateException - if validation fails

DAException - if a database error occurs

resetUnlockSheet

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

Resets the unlock request flag on the sheet to false.

Parameters:

sheetId - the ID of the sheet to reset

poolKit - the database connection pool kit for database operations

Throws:

DAValidateException - if validation fails

DAException - if a database error occurs

sendPushNotification

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

Sends a push notification to the user about the sheet unlock.

Parameters:

sheetId - the ID of the unlocked sheet

poolKit - the database connection pool kit for database operations

Throws:

DAException - if a database error occurs

DAValidateException - if validation fails

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

isValidExecution

public boolean isValidExecution()

Determines whether this task can be executed based on user permissions.

Specified by:

isValidExecution in interface ValidExecution

Overrides:

isValidExecution in class BTDataCollection<DataCollectionSheetInstanceUnlockEvent>

Returns:

true if the current user has permission to unlock sheets, false otherwise