Package de.uplanet.lucy.server.auxiliaries

Class VCFileHelper

java.lang.Object

de.uplanet.lucy.server.auxiliaries.VCFileHelper

@VelocityCallable("singleton")
public final class VCFileHelper
extends Object

Constructor Summary

Constructors

Constructor	Description
VCFileHelper()

Method Summary

Modifier and Type	Method	Description
File	copyFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strSrcFile, String p_strFieldGuid, Object p_recId, boolean p_bTriggerWorkflow)
File	copyFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strSrcFile, String p_strFieldGuid, Object p_recId, String p_strDestFileName, boolean p_bTriggerWorkflow)
File	copyFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strSrcFile, String p_strFieldGuid, Object p_recId, String p_strDestFileName, String p_strContentType, boolean p_bTriggerWorkflow)
void	deleteFileFromIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strFieldGuid, Object p_recId)
void	deleteFileFromIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strFieldGuid, Object p_recId, Object p_fileId)
String	getFileUrl(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strFieldGuid, Object p_recId)
de.uplanet.lucy.server.dataobjects.IFileValueHolder	getFileValueHolder(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strFieldGuid, Object p_recId)
File	moveFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strSrcFile, String p_strFieldGuid, Object p_recId, boolean p_bTriggerWorkflow)
File	moveFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strSrcFile, String p_strFieldGuid, Object p_recId, String p_strDestFileName, boolean p_bTriggerWorkflow)
File	moveFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strSrcFile, String p_strFieldGuid, Object p_recId, String p_strDestFileName, String p_strContentType, boolean p_bTriggerWorkflow)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VCFileHelper

public VCFileHelper()

Method Detail

copyFileToIntrexx

public File copyFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx,
                              String p_strSrcFile,
                              String p_strFieldGuid,
                              Object p_recId,
                              boolean p_bTriggerWorkflow)
                       throws Exception

Parameters:

p_ctx - The processing context.

p_strSrcFile - The source file.

p_strFieldGuid - The file data field GUID.

p_recId - The record ID.

p_bTriggerWorkflow - true if workflows should be triggered on change, or false otherwise.

Returns:

The copied file.

Throws:

Exception - If an error occurred.

copyFileToIntrexx

public File copyFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx,
                              String p_strSrcFile,
                              String p_strFieldGuid,
                              Object p_recId,
                              String p_strDestFileName,
                              boolean p_bTriggerWorkflow)
                       throws Exception

Parameters:

p_ctx - The processing context.

p_strSrcFile - The source file.

p_strFieldGuid - The file data field GUID.

p_recId - The record ID.

p_strDestFileName - The destination file name.

p_bTriggerWorkflow - true if workflows should be triggered on change, or false otherwise.

Returns:

The copied file.

Throws:

Exception - If an error occurred.

copyFileToIntrexx

public File copyFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx,
                              String p_strSrcFile,
                              String p_strFieldGuid,
                              Object p_recId,
                              String p_strDestFileName,
                              String p_strContentType,
                              boolean p_bTriggerWorkflow)
                       throws Exception

Parameters:

p_ctx - The processing context.

p_strSrcFile - The source file.

p_strFieldGuid - The file data field GUID.

p_recId - The record ID.

p_strDestFileName - The destination file name.

p_strContentType - The file content type.

p_bTriggerWorkflow - true if workflows should be triggered on change, or false otherwise.

Returns:

The copied file.

Throws:

Exception - If an error occurred.

moveFileToIntrexx

public File moveFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx,
                              String p_strSrcFile,
                              String p_strFieldGuid,
                              Object p_recId,
                              boolean p_bTriggerWorkflow)
                       throws Exception

Parameters:

p_ctx - The processing context.

p_strSrcFile - The source file.

p_strFieldGuid - The file data field GUID.

p_recId - The record ID.

p_bTriggerWorkflow - true if workflows should be triggered on change, or false otherwise.

Returns:

The moved file.

Throws:

Exception - If an error occurred.

moveFileToIntrexx

public File moveFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx,
                              String p_strSrcFile,
                              String p_strFieldGuid,
                              Object p_recId,
                              String p_strDestFileName,
                              boolean p_bTriggerWorkflow)
                       throws Exception

Parameters:

p_ctx - The processing context.

p_strSrcFile - The source file.

p_strFieldGuid - The file data field GUID.

p_recId - The record ID.

p_strDestFileName - The destination file name.

p_bTriggerWorkflow - true if workflows should be triggered on change, or false otherwise.

Returns:

The moved file.

Throws:

Exception - If an error occurred.

moveFileToIntrexx

public File moveFileToIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx,
                              String p_strSrcFile,
                              String p_strFieldGuid,
                              Object p_recId,
                              String p_strDestFileName,
                              String p_strContentType,
                              boolean p_bTriggerWorkflow)
                       throws Exception

Parameters:

p_ctx - The processing context.

p_strSrcFile - The source file.

p_strFieldGuid - The field GUID.

p_recId - The record ID.

p_strDestFileName - The destination file name.

p_strContentType - The content type.

p_bTriggerWorkflow - true if workflows should be triggered on change, or false otherwise.

Returns:

The moved file.

Throws:

Exception - If an error occurred.

deleteFileFromIntrexx

public void deleteFileFromIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx,
                                  String p_strFieldGuid,
                                  Object p_recId)
                           throws Exception

Parameters:

p_ctx - The processing context.

p_strFieldGuid - The file field GUID.

p_recId - The record GUID.

Throws:

Exception - If an error occurred.

deleteFileFromIntrexx

public void deleteFileFromIntrexx(de.uplanet.lucy.server.IProcessingContext p_ctx,
                                  String p_strFieldGuid,
                                  Object p_recId,
                                  Object p_fileId)
                           throws Exception

Parameters:

p_ctx - The processing context.

p_strFieldGuid - The file field GUID.

p_recId - The record id.

p_fileId - The file id

Throws:

Exception - If an error occurred.

getFileUrl

public String getFileUrl(de.uplanet.lucy.server.IProcessingContext p_ctx,
                         String p_strFieldGuid,
                         Object p_recId)
                  throws Exception

Parameters:

p_ctx - The processing context.

p_strFieldGuid - The data field GUID.

p_recId - The record ID.

Returns:

The URL to the file (could be null).

Throws:

Exception - If an error occurred.

getFileValueHolder

public de.uplanet.lucy.server.dataobjects.IFileValueHolder getFileValueHolder(de.uplanet.lucy.server.IProcessingContext p_ctx,
                                                                              String p_strFieldGuid,
                                                                              Object p_recId)
                                                                       throws Exception

Parameters:

p_ctx - The processing context.

p_strFieldGuid - The data field GUID.

p_recId - The record ID.

Returns:

A file value holder (could be null).

Throws:

Exception - If an error occurred.