Package overit.geocallapp.wfm.core.bl.datacollection.instance.task

Class BTDataCollectionSheetInstanceCancel

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionSheetInstanceCancelEvent>

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

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

overit.geocallapp.wfm.core.bl.datacollection.instance.task.BTDataCollectionSheetInstanceCancel

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionSheetInstanceCancelEvent.class)
public class BTDataCollectionSheetInstanceCancel
extends BTDataCollection<DataCollectionSheetInstanceCancelEvent>

Business task in order to cancel a DataCollectionSheetInstance.
When the DataCollectionSheetInstanceCancelEvent is launched the BT notices the call and cancels the DataCollectionSheetInstance basing on the event's input.

Permission:

• WfmPermissions.FSM_DATACOLLECTION_SHEET_EDIT

Errors:

• Codes.DATACOLLECTION_CANNOT_CANCEL_SHEET_STATUS_NOT_ALLOWED

Since:

12.0

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionSheetInstanceCancel()

Method Summary

Modifier and Type	Method	Description
protected void	checkSheet(BODataCollectionSheet sheet)	Checks the sheet.
protected void	execute(DataCollectionSheetInstanceCancelEvent event, PoolKit poolKit)	Cancels the sheet.
boolean	isValidExecution()	Checks whether the view sheet permission is activated or not.
protected BODataCollectionSheet	loadSheet(Long sheetId, PoolKit poolKit)	Loads the sheet.
protected void	updateSheet(BODataCollectionSheet sheet, PoolKit poolKit)	Updates the sheet.

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

BTDataCollectionSheetInstanceCancel

public BTDataCollectionSheetInstanceCancel()

Method Details

isValidExecution

public boolean isValidExecution()

Checks whether the view sheet permission is activated or not.

Specified by:

isValidExecution in interface ValidExecution

Overrides:

isValidExecution in class BTDataCollection<DataCollectionSheetInstanceCancelEvent>

Returns:

true, if the view sheet permission is active, false otherwise

execute

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

Cancels the sheet.

Specified by:

execute in class ValidExecutionBusinessTask<DataCollectionSheetInstanceCancelEvent>

Parameters:

event - the DataCollectionSheetInstanceCancelEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

checkSheet

protected void checkSheet(BODataCollectionSheet sheet)
                   throws DAValidateException,
DAException

Checks the sheet.

Parameters:

sheet - the BODataCollectionSheet

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadSheet

protected BODataCollectionSheet loadSheet(Long sheetId,
 PoolKit poolKit)
                                   throws DAValidateException,
DAException

Loads the sheet.

Parameters:

sheetId - the sheet id

poolKit - the PoolKit

Returns:

the BO data collection sheet

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateSheet

protected void updateSheet(BODataCollectionSheet sheet,
 PoolKit poolKit)
                    throws DAValidateException,
DAException

Updates the sheet.

Parameters:

sheet - the BODataCollectionSheet

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception