Interface IFileTransformationManager

  • All Known Subinterfaces:
    IFileTransformationManagerSPI
    All Known Implementing Classes:
    FileTransformationManager

    public interface IFileTransformationManager
    Interface to be implemented by transformation managers.
    Since:
    6.1.0
    Version:
    $Revision: 13752 $ $Date: 2011-10-13 14:10:51 -0300 (Thu, 13 Oct 2011) $
    • Method Detail

      • updateFileTransformation

        void updateFileTransformation​(SessionConfig sessionConfig,
                                      FileTransformation fileTransformation,
                                      ITransaction transaction)
                               throws PortalException
        Updates a given transformation.
        Parameters:
        sessionConfig - the current session configuration.
        fileTransformation - the file transformation to be updated
        transaction - the current transaction
        Throws:
        PortalException
        Since:
        6.1.0
      • getFileTransformationsByServiceInstanceId

        java.util.Collection<FileTransformation> getFileTransformationsByServiceInstanceId​(java.lang.String serviceInstanceId,
                                                                                           ITransaction transaction)
                                                                                    throws PortalException
        Returns all transformations for the given service instance.
        Parameters:
        serviceInstanceId - the wished service instance id.
        Returns:
        all transformations for the given service instance.
        Throws:
        PortalException
        Since:
        6.1.0
      • getFileTransformation

        FileTransformation getFileTransformation​(java.lang.String fileTransformationId,
                                                 ITransaction transaction)
                                          throws PortalException
        Return a given persisted transformation.
        Parameters:
        fileTransformationId - the wished transformation id.
        transaction - the transaction for persistence access.
        Returns:
        the found transformation
        Throws:
        PortalException
        Since:
        6.1.0
      • removeFileTransformation

        void removeFileTransformation​(SessionConfig sessionConfig,
                                      FileTransformation fileTransformation,
                                      ITransaction transaction)
                               throws PortalException
        Removes the specified transformation and its related files.

        This method only schedules the removal, that will occur asynchrounsly. But the removal will only occur if the given transaction commits.

        Parameters:
        sessionConfig - the current session configuration.
        fileTransformation - the file transformation responsible for the file creation.
        transaction - the transaction for persistence access.
        Throws:
        PortalException
        Since:
        6.1.0