Package overit.geocallapp.wfm.core.bl.timesheet.task

Class BTTimesheetClose

java.lang.Object

overit.geocall.bl.BusinessTask<TimesheetCloseEvent>

overit.geocallapp.wfm.core.bl.timesheet.task.BTTimesheet<TimesheetCloseEvent>

overit.geocallapp.wfm.core.bl.timesheet.task.BTTimesheetClose

All Implemented Interfaces:

Serializable, Tool

@Event(TimesheetCloseEvent.class)
public class BTTimesheetClose
extends BTTimesheet<TimesheetCloseEvent>

Business task in order to close a timesheet. When the TimesheetCloseEvent is launched the BT notices the call, checks the timesheet closing conditions and eventually changes the Timesheet state to BOTimesheetState.Values.TO_BE_VALIDATED or BOTimesheetState.Values.VALIDATED, whether the validation is enabled or not.

Required fields:

• timesheet id

Error code:

• Codes.Timesheet.Validation.TIMESHEET_NOT_EDITABLE
• Codes.Timesheet.Validation.BLOCKING_WARNINGS_FOUND
• Codes.Timesheet.Validation.SHIFT_WITHOUT_TASK
• Codes.Timesheet.Validation.TASK_NOT_CLOSED

Since:

9.2

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTTimesheetClose()

Method Summary

Modifier and Type	Method	Description
protected void	changeTimesheetState(TimesheetEntitiesAggregate aggregate, PoolKit poolKit)	Changes the timesheet state to BOTimesheetState.Values.TO_BE_VALIDATED or BOTimesheetState.Values.VALIDATED, whether the validation is enabled or not.
protected void	checkClosingConditions(TimesheetEntitiesAggregate aggregate, PoolKit poolKit)	Checks all closing conditions before closing the timesheet.
protected void	checkTaskEndDate(TimesheetEntitiesAggregate aggregate)	Checks the task end date for every timesheet task.
protected void	checkTaskPresence(TimesheetEntitiesAggregate aggregate, PoolKit poolKit)	Checks the task presence for every timesheet shift.
protected void	checkTimesheetState(TimesheetEntitiesAggregate aggregate)	Checks the timesheet state for this operation.
protected void	checkTimesheetWarnings(TimesheetEntitiesAggregate aggregate)	Checks the timesheet blocking warnings.
protected void	execute(TimesheetCloseEvent event, PoolKit poolKit)	Performs the closure of the timesheet.
protected TimesheetEntitiesAggregate	loadAggregate(Timesheet timesheet, PoolKit poolKit)	It loads the timesheet aggregate object.
protected Timesheet	loadTimesheet(Long timesheetId, PoolKit poolKit)	Loads the Timesheet from the given id.

Methods inherited from class overit.geocallapp.wfm.core.bl.timesheet.task.BTTimesheet

body, checkTimesheetActivation, throwInactiveTimesheetException

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

BTTimesheetClose

public BTTimesheetClose()

Method Details

execute

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

Performs the closure of the timesheet.

Specified by:

execute in class BTTimesheet<TimesheetCloseEvent>

Parameters:

event - the TimesheetCloseEvent

poolKit - the pool kit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadTimesheet

protected Timesheet loadTimesheet(Long timesheetId,
 PoolKit poolKit)
                           throws DAValidateException,
DAException

Loads the Timesheet from the given id.

Parameters:

timesheetId - the timesheet id

poolKit - the pool kit

Returns:

the loaded Timesheet

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadAggregate

protected TimesheetEntitiesAggregate loadAggregate(Timesheet timesheet,
 PoolKit poolKit)
                                            throws DAValidateException,
DAException

It loads the timesheet aggregate object.

Parameters:

timesheet - the given Timesheet used to load all the related entities of the aggregate

poolKit - the pool kit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkClosingConditions

protected void checkClosingConditions(TimesheetEntitiesAggregate aggregate,
 PoolKit poolKit)
                               throws DAValidateException,
DAException

Checks all closing conditions before closing the timesheet.

Parameters:

aggregate - the timesheet aggregate

poolKit - the pool kit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkTimesheetState

protected void checkTimesheetState(TimesheetEntitiesAggregate aggregate)
                            throws DAValidateException

Checks the timesheet state for this operation.

Parameters:

aggregate - the timesheet aggregate

Throws:

DAValidateException - the DA validate exception

checkTimesheetWarnings

protected void checkTimesheetWarnings(TimesheetEntitiesAggregate aggregate)
                               throws DAValidateException

Checks the timesheet blocking warnings.

Parameters:

aggregate - the timesheet aggregate

Throws:

DAValidateException - the DA validate exception

checkTaskPresence

protected void checkTaskPresence(TimesheetEntitiesAggregate aggregate,
 PoolKit poolKit)
                          throws DAValidateException,
DAException

Checks the task presence for every timesheet shift.

Parameters:

aggregate - the timesheet aggregate

poolKit - the pool kit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkTaskEndDate

protected void checkTaskEndDate(TimesheetEntitiesAggregate aggregate)
                         throws DAValidateException

Checks the task end date for every timesheet task.

Parameters:

aggregate - the timesheet aggregate

Throws:

DAValidateException - the DA validate exception

changeTimesheetState

protected void changeTimesheetState(TimesheetEntitiesAggregate aggregate,
 PoolKit poolKit)
                             throws DAValidateException,
DAException

Changes the timesheet state to BOTimesheetState.Values.TO_BE_VALIDATED or BOTimesheetState.Values.VALIDATED, whether the validation is enabled or not.

Parameters:

aggregate - the timesheet aggregate

poolKit - the pool kit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception