com.filenet.api.engine

Interface ContentConversionHandler

public interface ContentConversionHandler

This interface is not supported.

Method Summary

Methods

Modifier and Type	Method and Description
void	convertFile(java.lang.String inputContentFile, java.lang.String inputContentType, java.lang.String retrievalName, CmContentConversionAction action, CmContentConversionSettings outputSettings, ContentConversionResult result) Converts source content from specified source content type to target content type
void	convertStream(java.io.InputStream inputContentStream, java.lang.String inputContentType, java.lang.String retrievalName, CmContentConversionAction action, CmContentConversionSettings outputSettings, ContentConversionResult result) Converts source content from specified source content type to target content type
boolean	isSynchronous(java.lang.String outputConversionClassName) Indicates whether this content conversion handler delivers conversion result synchronously or not
boolean	requiresFile(java.lang.String outputConversionClassName) Indicates whether this content conversion handler requires source content in a file or not
void	resumeConversion(CmContentConversionAction action, byte[] deferralData, CmContentConversionSettings outputSettings, ContentConversionResult result) Returns previously submitted conversions operation's current status or result if completed

Method Detail

requiresFile

boolean requiresFile(java.lang.String outputConversionClassName)

Indicates whether this content conversion handler requires source content in a file or not

Parameters:

outputConversionClassName - CmContentConversionSettings class name

isSynchronous

boolean isSynchronous(java.lang.String outputConversionClassName)

Indicates whether this content conversion handler delivers conversion result synchronously or not

Parameters:

outputConversionClassName - CmContentConversionSettings class name

convertStream

void convertStream(java.io.InputStream inputContentStream,
                 java.lang.String inputContentType,
                 java.lang.String retrievalName,
                 CmContentConversionAction action,
                 CmContentConversionSettings outputSettings,
                 ContentConversionResult result)

Converts source content from specified source content type to target content type

Parameters:

inputContentStream - InputStream of content to be converted

inputContentType - Content type of content to be converted

retrievalName - Retrieval name of content element to be converted

action - CmContentConversionAction instance representing this content conversion handler

outputSettings - CmContentConversionSettings instance for this conversion output content type

result - Result object to store conversion output

convertFile

void convertFile(java.lang.String inputContentFile,
               java.lang.String inputContentType,
               java.lang.String retrievalName,
               CmContentConversionAction action,
               CmContentConversionSettings outputSettings,
               ContentConversionResult result)

Converts source content from specified source content type to target content type

Parameters:

inputContentFile - File path to content to be converted

inputContentType - Content type of content to be converted

retrievalName - Retrieval name of source content element

action - CmContentConversionAction instance representing this content conversion handler

outputSettings - CmContentConversionSettings instance for this conversion output content type

result - Result object to store conversion output

resumeConversion

void resumeConversion(CmContentConversionAction action,
                    byte[] deferralData,
                    CmContentConversionSettings outputSettings,
                    ContentConversionResult result)

Returns previously submitted conversions operation's current status or result if completed

Parameters:

action - CmContentConversionAction instance representing this content conversion handler

deferralData - Continuation cookie from previously submitted conversion operation

outputSettings - CmContentConversionSettings instance for this conversion output content type

result - Result object to store conversion output