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

Class BTDataCollectionSheetInstanceUnlockCheck

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionSheetInstanceUnlockCheckEvent>

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

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

overit.geocallapp.wfm.orchestrator.documents.mobileforms.bl.instance.task.BTDataCollectionSheetInstanceUnlockCheckBase<DataCollectionSheetInstanceUnlockCheckEvent>

overit.geocallapp.wfm.orchestrator.documents.mobileforms.bl.instance.task.BTDataCollectionSheetInstanceUnlockCheck

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionSheetInstanceUnlockCheckEvent.class)
public class BTDataCollectionSheetInstanceUnlockCheck
extends BTDataCollectionSheetInstanceUnlockCheckBase<DataCollectionSheetInstanceUnlockCheckEvent>

Business task for validating if a data collection sheet can be unlocked.

This task processes DataCollectionSheetInstanceUnlockCheckEvent events and performs comprehensive validation to determine if a sheet meets all requirements for unlocking.

The validation workflow checks:

1. Lock/unlock feature is enabled for the sheet
2. An unlock request has been submitted
3. Sheet is in closed state
4. Sheet scope is associated with work order operations
5. Sheet is linked to a work order operation
6. Associated work order is in an open state (unless superuser override)

Superuser Override: Users with superuser permissions can bypass the work order open state validation, allowing unlocking of sheets associated with closed work orders.

Since:

22.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class overit.geocallapp.wfm.orchestrator.documents.mobileforms.bl.instance.task.BTDataCollectionSheetInstanceUnlockCheckBase

documentsIntegrationService

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionSheetInstanceUnlockCheck()

Method Summary

Modifier and Type	Method	Description
protected void	checkRequestedUnlocking(BODataCollectionSheet sheet)	Validates that the sheet has an unlock request pending.
protected void	execute(DataCollectionSheetInstanceUnlockCheckEvent event, PoolKit poolKit)	Executes the unlock validation workflow.

Methods inherited from class overit.geocallapp.wfm.orchestrator.documents.mobileforms.bl.instance.task.BTDataCollectionSheetInstanceUnlockCheckBase

checkAssociatedToOperation, checkClosed, checkLockUnlockEnabled, checkOperation, checkSheet, checkWorkorderOpen, getIntegrationService, loadSheet

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

BTDataCollectionSheetInstanceUnlockCheck

public BTDataCollectionSheetInstanceUnlockCheck()

Method Details

execute

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

Executes the unlock validation workflow.

Specified by:

execute in class ValidExecutionBusinessTask<DataCollectionSheetInstanceUnlockCheckEvent>

Parameters:

event - the unlock check 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

checkRequestedUnlocking

protected void checkRequestedUnlocking(BODataCollectionSheet sheet)
                                throws DAValidateException

Validates that the sheet has an unlock request pending.

Parameters:

sheet - the data collection sheet to validate

Throws:

DAValidateException - if the sheet does not have an unlock request (error code: DATACOLLECTION_NOT_REQUESTED_UNLOCKING)