Package overit.geocallapp.wfm.orchestrator.workorders.bl.task

Class BTWorkOrderCreationFromWorkCycle

java.lang.Object

overit.geocall.bl.BusinessTask<WorkOrderCreationFromWorkCycleEvent>

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

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

overit.geocallapp.wfm.orchestrator.workorders.bl.task.BTWorkOrderCreationFromWorkCycle

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(WorkOrderCreationFromWorkCycleEvent.class)
public class BTWorkOrderCreationFromWorkCycle
extends ValidPermissionBusinessTask<WorkOrderCreationFromWorkCycleEvent>

Business task to insert a work order from work cycle.

Permission:

• WorkOrderPermissions.WORK_ORDER_EDIT

Error Code:

• Codes.PROPERTY_REQUIRED
• Codes.WorkOrderCreationFromWorkCycle.WORK_CYCLE_NOT_ACTIVE
• Codes.WorkOrderCreationFromWorkCycle.WORK_ORDER_HEADER_TYPE_NOT_ACTIVE
• Codes.WorkOrderCreationFromWorkCycle.WORK_ORDER_OPERATION_TYPE_NOT_ACTIVE

Since:

18.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkOrdersIntegrationService	integrationService
protected Long	operationOrdering
protected BOWorkCycle	workCycle

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTWorkOrderCreationFromWorkCycle()

Method Summary

Modifier and Type	Method	Description
protected void	activateWorkOrder(Long workOrderHeaderId, PoolKit poolKit)	Activate the work order
protected void	addOperation(List<BOWorkOrderOperation> workOrderOperations, BOWorkOrderOperation operation)	Adds an operation to the list of work order operations.
protected void	completeWorkOrderHeaderFromWorkCycle(BOWorkOrderHeader woHeader)	Generation of unique code for the work order starting from the operationCenterId and completion of the fields in the BOWorkOrderHeader from the BOWorkCycle.
protected void	completeWorkOrderOperationFromWorkCycleStructure(BOWorkOrderOperation woOperation, BOWorkOrderHeader woHeader, BOWorkCycleStructure workCycleStructure, Long addressId, Long ordering)	Completion of the fields in the BOWorkOrderOperation from the BOWorkCycleStructure.
protected void	createRepeatableOperation(BOWorkOrderHeader woHeader, BOWorkCycleStructure workCycleStructure, List<BOWorkOrderOperation> woOperations, PoolKit poolKit)	Creation of a BOWorkOrderOperation starting from a repeatable BOWorkCycleStructure.
protected void	createSingleOperation(BOWorkOrderHeader woHeader, BOWorkCycleStructure workCycleStructure, List<BOWorkOrderOperation> woOperations, PoolKit poolKit)	Creation of a BOWorkOrderOperation starting from a non-repeatable BOWorkCycleStructure.
protected List<BOWorkOrderOperation>	createWoOperations(BOWorkOrderHeader woHeader, PoolKit poolKit)	Creates a list of BOWorkOrderOperation based on the provided work order header and work cycle structures.
protected void	execute(WorkOrderCreationFromWorkCycleEvent event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected WorkOrdersIntegrationService	getIntegrationService(PoolKit poolKit)	Returns the integration service.
protected Long	getTechnicalObjectType(BOWorkCycleStructure workCycleStructure, PoolKit poolKit)	Return the technical object type for work order operation type or work order type
protected void	insertOperations(Long workOrderHeaderId, List<BOWorkOrderOperation> woOperations, PoolKit poolKit)	Insert the list of BOWorkOrderOperation .
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected List<BOAsset>	searchAssetDescendants(BOWorkCycleStructure workCycleStructure, Long assetId, PoolKit poolKit)	Searches for the descendants of an asset based on the provided asset id and asset status from work cycle structure.
protected List<BOWorkCycleStructure>	searchWorkCycleStructure(BOWorkOrderHeader woHeader, PoolKit poolKit)	Searches for work cycle structures based on the provided work order header.
protected void	validateWorkOrderHeader(BOWorkOrderHeader woHeader, PoolKit poolKit)	Check on mandatory fields and visibility of properties.
protected void	validateWorkOrderOperation(BOWorkCycleStructure workCycleStructure, PoolKit poolKit)	Check on the visibility of the properties of the BOWorkOrderOperation

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

integrationService

protected WorkOrdersIntegrationService integrationService

workCycle

protected BOWorkCycle workCycle

operationOrdering

protected Long operationOrdering

Constructor Details

BTWorkOrderCreationFromWorkCycle

public BTWorkOrderCreationFromWorkCycle()

Method Details

execute

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

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

createWoOperations

protected List<BOWorkOrderOperation> createWoOperations(BOWorkOrderHeader woHeader,
 PoolKit poolKit)
                                                 throws DAException,
DAValidateException

Creates a list of BOWorkOrderOperation based on the provided work order header and work cycle structures.

Parameters:

woHeader - the BOWorkOrderHeader

poolKit - the PoolKit

Returns:

the list of BOWorkOrderOperation

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

validateWorkOrderHeader

protected void validateWorkOrderHeader(BOWorkOrderHeader woHeader,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Check on mandatory fields and visibility of properties.

Parameters:

woHeader - the BOWorkOrderHeader

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

completeWorkOrderHeaderFromWorkCycle

protected void completeWorkOrderHeaderFromWorkCycle(BOWorkOrderHeader woHeader)

Generation of unique code for the work order starting from the operationCenterId and completion of the fields in the BOWorkOrderHeader from the BOWorkCycle.

Parameters:

woHeader - the BOWorkOrderHeader

insertOperations

protected void insertOperations(Long workOrderHeaderId,
 List<BOWorkOrderOperation> woOperations,
 PoolKit poolKit)
                         throws DAValidateException,
DAException

Insert the list of BOWorkOrderOperation .

Parameters:

workOrderHeaderId - the BOWorkOrderHeader id

woOperations - the list of BOWorkOrderOperation

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

searchWorkCycleStructure

protected List<BOWorkCycleStructure> searchWorkCycleStructure(BOWorkOrderHeader woHeader,
 PoolKit poolKit)
                                                       throws DAValidateException,
DAException

Searches for work cycle structures based on the provided work order header.

Parameters:

woHeader - the BOWorkOrderHeader

poolKit - the PoolKit

Returns:

the list of BOWorkCycleStructure

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

createSingleOperation

protected void createSingleOperation(BOWorkOrderHeader woHeader,
 BOWorkCycleStructure workCycleStructure,
 List<BOWorkOrderOperation> woOperations,
 PoolKit poolKit)
                              throws DAException,
DAValidateException

Creation of a BOWorkOrderOperation starting from a non-repeatable BOWorkCycleStructure.

Parameters:

woHeader - the BOWorkOrderHeader

workCycleStructure - the BOWorkCycleStructure

woOperations - the list of BOWorkOrderOperation

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

createRepeatableOperation

protected void createRepeatableOperation(BOWorkOrderHeader woHeader,
 BOWorkCycleStructure workCycleStructure,
 List<BOWorkOrderOperation> woOperations,
 PoolKit poolKit)
                                  throws DAException,
DAValidateException

Creation of a BOWorkOrderOperation starting from a repeatable BOWorkCycleStructure. This involves extracting the descendants of an asset and creating an operation for each asset.

Parameters:

woHeader - the BOWorkOrderHeader

workCycleStructure - the BOWorkCycleStructure

woOperations - the list of BOWorkOrderOperation

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

addOperation

protected void addOperation(List<BOWorkOrderOperation> workOrderOperations,
 BOWorkOrderOperation operation)
                     throws DAValidateException

Adds an operation to the list of work order operations. If the size of the list exceeds the maximum allowed number of operations, a DAValidateException is thrown.

Parameters:

workOrderOperations - the list of BOWorkOrderOperation

operation - the BOWorkOrderOperation to be added

Throws:

DAValidateException - if the maximum number of operations is exceeded

searchAssetDescendants

protected List<BOAsset> searchAssetDescendants(BOWorkCycleStructure workCycleStructure,
 Long assetId,
 PoolKit poolKit)
                                        throws DAValidateException,
DAException

Searches for the descendants of an asset based on the provided asset id and asset status from work cycle structure.

Parameters:

workCycleStructure - the BOWorkCycleStructure

assetId - the id of the asset to search for descendants.

poolKit - the PoolKit

Returns:

the list of BOAsset objects representing the descendants of the asset.

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getTechnicalObjectType

protected Long getTechnicalObjectType(BOWorkCycleStructure workCycleStructure,
 PoolKit poolKit)
                               throws DAValidateException,
DAException

Return the technical object type for work order operation type or work order type

Parameters:

workCycleStructure - the BOWorkCycleStructure

poolKit - the PoolKit

Returns:

the technical object type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

validateWorkOrderOperation

protected void validateWorkOrderOperation(BOWorkCycleStructure workCycleStructure,
 PoolKit poolKit)
                                   throws DAException,
DAValidateException

Check on the visibility of the properties of the BOWorkOrderOperation

Parameters:

workCycleStructure - the BOWorkCycleStructure

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

completeWorkOrderOperationFromWorkCycleStructure

protected void completeWorkOrderOperationFromWorkCycleStructure(BOWorkOrderOperation woOperation,
 BOWorkOrderHeader woHeader,
 BOWorkCycleStructure workCycleStructure,
 Long addressId,
 Long ordering)

Completion of the fields in the BOWorkOrderOperation from the BOWorkCycleStructure.

Parameters:

woOperation - the BOWorkOrderOperation

woHeader - the BOWorkOrderHeader

workCycleStructure - the BOWorkCycleStructure

activateWorkOrder

protected void activateWorkOrder(Long workOrderHeaderId,
 PoolKit poolKit)
                          throws DAValidateException,
DAException

Activate the work order

Parameters:

workOrderHeaderId - the work order id

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getIntegrationService

protected WorkOrdersIntegrationService getIntegrationService(PoolKit poolKit)
                                                      throws DAValidateException

Returns the integration service.

Parameters:

poolKit - the PoolKit

Returns:

the integration service

Throws:

DAValidateException - the DA validate exception

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