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

Class BTWorkOrderHeaderInsert

java.lang.Object

overit.geocall.bl.BusinessTask<WorkOrderHeaderInsertEvent>

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

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

overit.geocallapp.wfm.workorders.bl.header.task.BTWorkOrderHeaderInsert

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(WorkOrderHeaderInsertEvent.class)
public class BTWorkOrderHeaderInsert
extends ValidPermissionBusinessTask<WorkOrderHeaderInsertEvent>

Business task to insert a work order header.
The new work order is created in a draft state.

Permission:

• WorkOrderPermissions.WORK_ORDER_EDIT

Error Code:

• Codes.PROPERTY_REQUIRED
• Codes.CODE_MUST_BE_UNIQUE
• Codes.WorkOrderHeader.BOOKING_WORKORDER_TYPES_NOT_ALLOWED
• Codes.INVALID_DATE_INTERVAL_BEFORE

Since:

16.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkOrderHelper	helper

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTWorkOrderHeaderInsert()

Method Summary

Modifier and Type	Method	Description
protected String	calculateNewCode(Long operationCenterId, Long workOrderId, PoolKit poolKit)	Method that calculate the work order code if the code in input is null.
protected void	checkCode(BOWorkOrderHeader header, PoolKit poolKit)	Method that check the code, these checks are done only if the code is an input property
protected void	execute(WorkOrderHeaderInsertEvent event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected Long	insertWoHeader(BOWorkOrderHeader header, PoolKit poolKit)	Insert the BOWorkOrderHeader and generate a new code if the input code is null
boolean	isValidExecution()	Determines whether the current state is valid for execution.

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

helper

protected transient WorkOrderHelper helper

Constructor Details

BTWorkOrderHeaderInsert

public BTWorkOrderHeaderInsert()

Method Details

execute

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

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

checkCode

protected void checkCode(BOWorkOrderHeader header,
 PoolKit poolKit)
                  throws DAValidateException,
DAException

Method that check the code, these checks are done only if the code is an input property

Parameters:

header - the work order input header

poolKit - the PoolKit

Throws:

DAValidateException

DAException

insertWoHeader

protected Long insertWoHeader(BOWorkOrderHeader header,
 PoolKit poolKit)
                       throws DAValidateException,
DAException

Insert the BOWorkOrderHeader and generate a new code if the input code is null

Parameters:

header - the BOWorkOrderHeader to insert

poolKit - the PoolKit

Throws:

DAException

DAValidateException

calculateNewCode

protected String calculateNewCode(Long operationCenterId,
 Long workOrderId,
 PoolKit poolKit)
                           throws DAException,
DAValidateException

Method that calculate the work order code if the code in input is null. If the operation center is null the calculated code will be a default one, if the operation center is not null then the event WorkOrderGenerateCodeEvent will be called.

Parameters:

operationCenterId - the operation center id

workOrderId - the work order id

poolKit - the PoolKit

Returns:

a string with the new work order code

Throws:

DAException - the DAException generic error thrown if there are code related errors

DAValidateException - the DAValidateException thrown if there are data related loading errors

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