Package overit.geocallapp.docshare.documents.bl.sharedresource.file.task

Class BTFileDelete

java.lang.Object

overit.geocall.bl.BusinessTask<FileDeleteEvent>

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

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

overit.geocallapp.docshare.documents.bl.sharedresource.file.task.BTFileDelete

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(FileDeleteEvent.class)
public class BTFileDelete
extends ValidPermissionBusinessTask<FileDeleteEvent>

Business task that manages file version deletion.
When a FileDeleteEvent is launched, this task:

• sets to true the deleted flag of the BOFile version
• possibly deletes the associated physical file

Since:

14.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTFileDelete()

Method Summary

Modifier and Type	Method	Description
protected void	deleteFile(BOFile file)	Deletes the physical file associated to the given BOFile.
protected void	execute(FileDeleteEvent event, PoolKit poolKit)	Deletes a BOFile version and possibly deletes the physical file associated with it.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected BOFile	loadFile(FileDeleteInput input, PoolKit poolKit)	Loads the BOFile by the given FileDeleteInput.
protected BOFile	loadFileByVersion(String fileUuid, Long version, PoolKit poolKit)	Loads the file based on the given uuid and version.
protected BOFile	loadMainVersionFile(String fileUuid, PoolKit poolKit)	Loads the main version of the file.
protected void	updateFile(BOFile file, PoolKit poolKit)	Updates the given BOFile.
protected void	validate(FileDeleteInput input, PoolKit poolKit)	Validates the given event input.

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

Constructor Details

BTFileDelete

public BTFileDelete()

Method Details

execute

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

Deletes a BOFile version and possibly deletes the physical file associated with it.

Specified by:

execute in class ValidExecutionBusinessTask<FileDeleteEvent>

Parameters:

event - the FileDeleteEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

validate

protected void validate(FileDeleteInput input,
 PoolKit poolKit)
                 throws DAValidateException,
DAException

Validates the given event input.

Parameters:

input - the FileDeleteInput

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadFile

protected BOFile loadFile(FileDeleteInput input,
 PoolKit poolKit)
                   throws DAValidateException,
DAException

Loads the BOFile by the given FileDeleteInput.

Parameters:

input - the FileDeleteInput

poolKit - the PoolKit

Returns:

the BOFile to delete

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadMainVersionFile

protected BOFile loadMainVersionFile(String fileUuid,
 PoolKit poolKit)
                              throws DAValidateException,
DAException

Loads the main version of the file.

Parameters:

fileUuid - the BOFile uuid

poolKit - the PoolKit

Returns:

the loaded BOFile

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadFileByVersion

protected BOFile loadFileByVersion(String fileUuid,
 Long version,
 PoolKit poolKit)
                            throws DAValidateException,
DAException

Loads the file based on the given uuid and version.

Parameters:

fileUuid - the BOFile uuid

version - the version

poolKit - the PoolKit

Returns:

the loaded BOFile

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

updateFile

protected void updateFile(BOFile file,
 PoolKit poolKit)
                   throws DAValidateException,
DAException

Updates the given BOFile.

Parameters:

file - the BOFile to update

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

deleteFile

protected void deleteFile(BOFile file)
                   throws DAValidateException

Deletes the physical file associated to the given BOFile.

Parameters:

file - the BOFile

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