Class FileUCHelper


  • @Scriptable
    public final class FileUCHelper
    extends Object
    • Method Detail

      • copyFileToIntrexx

        public static File copyFileToIntrexx​(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 - Not implemented, always false
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             String p_strSrcFile,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      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 - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             boolean p_bTriggerWorkflow)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - The source file.
        p_strFieldGuid - The file data field GUID.
        p_recId - The record ID.
        p_bTriggerWorkflow - Not implemented, always false
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - The source file.
        p_strFieldGuid - The file data field GUID.
        p_recId - The record ID.
        p_bTriggerWorkflow - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(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 - Not implemented, always false
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             String p_strSrcFile,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      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 - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             boolean p_bTriggerWorkflow)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - The source file.
        p_strFieldGuid - The file data field GUID.
        p_recId - The record ID.
        p_strDestFileName - The destination file name.
        p_bTriggerWorkflow - Not implemented, always false
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - The source file.
        p_strFieldGuid - The file data field GUID.
        p_recId - The record ID.
        p_strDestFileName - The destination file name.
        p_bTriggerWorkflow - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(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 - Not implemented, always false
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             String p_strSrcFile,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             String p_strContentType,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      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 - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             String p_strContentType,
                                             boolean p_bTriggerWorkflow)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - 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 - Not implemented, always false
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • copyFileToIntrexx

        public static File copyFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             String p_strContentType,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - 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 - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The copied file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(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 - Not implemented, always false
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             String p_strSrcFile,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      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 - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             boolean p_bTriggerWorkflow)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - The source file.
        p_strFieldGuid - The file data field GUID.
        p_recId - The record ID.
        p_bTriggerWorkflow - Not implemented, always false
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - The source file.
        p_strFieldGuid - The file data field GUID.
        p_recId - The record ID.
        p_bTriggerWorkflow - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(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 - Not implemented, always false
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             String p_strSrcFile,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      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 - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             boolean p_bTriggerWorkflow)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - The source file.
        p_strFieldGuid - The file data field GUID.
        p_recId - The record ID.
        p_strDestFileName - The destination file name.
        p_bTriggerWorkflow - Not implemented, always false
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - The source file.
        p_strFieldGuid - The file data field GUID.
        p_recId - The record ID.
        p_strDestFileName - The destination file name.
        p_bTriggerWorkflow - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(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 - Not implemented, always false
        Returns:
        The moved file.
        Throws:
        Exception
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             String p_strSrcFile,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             String p_strContentType,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      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 - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The moved file.
        Throws:
        Exception
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             String p_strContentType,
                                             boolean p_bTriggerWorkflow)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - 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 - Not implemented, always false
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • moveFileToIntrexx

        public static File moveFileToIntrexx​(IProcessingContext p_ctx,
                                             File p_fileSrc,
                                             String p_strFieldGuid,
                                             Object p_recId,
                                             String p_strDestFileName,
                                             String p_strContentType,
                                             boolean p_bTriggerWorkflow,
                                             boolean p_bAppendMode)
                                      throws Exception
        Parameters:
        p_ctx - The processing context.
        p_fileSrc - 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 - Not implemented, always false
        p_bAppendMode - Should be true if the file should be added to an multi file field otherwise the files of the multi file field will replaced with this one.
        Returns:
        The moved file.
        Throws:
        Exception - If an error occurred.
      • deleteFileFromIntrexx

        public static void deleteFileFromIntrexx​(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.
      • getFileValueHolder

        public static IFileValueHolder getFileValueHolder​(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.
      • updateFileByCopyToIntrexx

        public static void updateFileByCopyToIntrexx​(IProcessingContext p_ctx,
                                                     File p_fileSrc,
                                                     String p_strFieldGuid,
                                                     Object p_recId,
                                                     String p_strFileId,
                                                     String p_strDestFileName,
                                                     String p_strContentType)
                                              throws Exception
        Replaces a file in a multi file field
        Parameters:
        p_ctx - The processing context.
        p_strFieldGuid - The file field GUID.
        p_recId - The record GUID.
        p_strFileId - file ID.
        p_strDestFileName - Destination file name
        p_strContentType - Content type
        Throws:
        Exception - If an error occurred.
      • updateFileByMoveToIntrexx

        public static void updateFileByMoveToIntrexx​(IProcessingContext p_ctx,
                                                     File p_fileSrc,
                                                     String p_strFieldGuid,
                                                     Object p_recId,
                                                     String p_strFileId)
                                              throws Exception
        Replaces a file by moving in a multi file field
        Parameters:
        p_ctx - The processing context.
        p_strFieldGuid - The file field GUID.
        p_recId - The record GUID.
        p_strFileId - file ID.
        Throws:
        Exception - If an error occurred.
      • updateFileByMoveToIntrexx

        public static void updateFileByMoveToIntrexx​(IProcessingContext p_ctx,
                                                     File p_fileSrc,
                                                     String p_strFieldGuid,
                                                     Object p_recId,
                                                     String p_strFileId,
                                                     String p_strDestFileName,
                                                     String p_strContentType)
                                              throws Exception
        Replaces a file by moving in a multi file field
        Parameters:
        p_ctx - The processing context.
        p_strFieldGuid - The file field GUID.
        p_recId - The record GUID.
        p_strFileId - file ID.
        p_strDestFileName - Destination file name
        p_strContentType - Content type
        Throws:
        Exception - If an error occurred.