com.filenet.api.engine

Interface ContentConversionServices

public interface ContentConversionServices

This interface is not supported.

Method Summary

Methods

Modifier and Type	Method and Description
ContentConversionResult	convert(ObjectStore objStore, IndependentlyPersistableObject sourceObject, int elementSequenceNumber, CmContentConversionSettings outputSettings, boolean allowAsync) Converts the specified content element to the specified target content type.
ContentConversionResult	convert(ObjectStore objStore, java.io.InputStream inputContentStream, java.lang.String inputContentType, java.lang.String retrievalName, CmContentConversionSettings outputSettings, boolean allowAsync) Converts the input content to the specified target content type.
ContentConversionResult	convert(ObjectStore objStore, java.lang.String inputContentFile, java.lang.String inputContentType, java.lang.String retrievalName, CmContentConversionSettings outputSettings, boolean allowAsync) Converts the input content to athe specified target content type.
CmContentConversionSettings	copySettings(CmContentConversionSettings src) Creates a copy of the specified CmContentConversionSettings instance.
CmContentConversionSettings	createDefaultSettings(ObjectStore objStore, java.lang.String conversionSettingsClass) Creates an instance initialized with the default property values of the specified conversion settings class.
boolean	isConversionAvailable(ObjectStore objStore, java.lang.String inputContentType, java.lang.String conversionSettingsClass, boolean allowAsync) Checks whether the conversion from the specified input to the output content type is available or not.
ContentConversionResult	resume(ObjectStore objStore, byte[] deferralData, CmContentConversionSettings outputSettings) Checks and collects the result if the previously submitted conversion request has completed.

Method Detail

convert

ContentConversionResult convert(ObjectStore objStore,
                              IndependentlyPersistableObject sourceObject,
                              int elementSequenceNumber,
                              CmContentConversionSettings outputSettings,
                              boolean allowAsync)

Converts the specified content element to the specified target content type.

Parameters:

objStore - Object store where source object resides.

sourceObject - Object whose content needs to be converted.

elementSequenceNumber - elementSequenceNumber of content element that needs to be converted.

outputSettings - CmContentConversionSettings instance for this conversion output content type.

allowAsync - Indicates if caller can handle asynchronous conversion.

Returns:

ContentConversionResult The results of this conversion operation.

convert

ContentConversionResult convert(ObjectStore objStore,
                              java.lang.String inputContentFile,
                              java.lang.String inputContentType,
                              java.lang.String retrievalName,
                              CmContentConversionSettings outputSettings,
                              boolean allowAsync)

Converts the input content to athe specified target content type.

Parameters:

objStore - Object store where source content resides.

inputContentFile - File path to content to be converted.

inputContentType - Content type of content to be converted.

retrievalName - Retrieval name of source content element.

outputSettings - CmContentConversionSettings instance for this conversion output content type.

allowAsync - Indicates if caller can handle asynchronous conversion.

Returns:

ContentConversionResult The results of this conversion operation.

convert

ContentConversionResult convert(ObjectStore objStore,
                              java.io.InputStream inputContentStream,
                              java.lang.String inputContentType,
                              java.lang.String retrievalName,
                              CmContentConversionSettings outputSettings,
                              boolean allowAsync)

Converts the input content to the specified target content type.

Parameters:

objStore - Object store where source content resides.

inputContentStream - InputStream of content to be converted.

inputContentType - Content type of content to be converted.

retrievalName - Retrieval name of source content element.

outputSettings - CmContentConversionSettings instance for this conversion output content type.

allowAsync - Indicates if caller can handle asynchronous conversion.

Returns:

ContentConversionResult The results of this conversion operation.

isConversionAvailable

boolean isConversionAvailable(ObjectStore objStore,
                            java.lang.String inputContentType,
                            java.lang.String conversionSettingsClass,
                            boolean allowAsync)

Checks whether the conversion from the specified input to the output content type is available or not.

Parameters:

inputContentType - Content type of content to be converted.

conversionSettingsClass - CmContentConversionSettings subclass for a needed conversion output content type.

allowAsync - Indicates if caller can handle asynchronous conversion.

Returns:

True or false.

createDefaultSettings

CmContentConversionSettings createDefaultSettings(ObjectStore objStore,
                                                java.lang.String conversionSettingsClass)

Creates an instance initialized with the default property values of the specified conversion settings class.

Parameters:

objStore - Object store to use.

conversionSettingsClass - CmContentConversionSettings subclass for a needed conversion output content type.

Returns:

An instance of conversionSettingsClass initialized with default property values.

copySettings

CmContentConversionSettings copySettings(CmContentConversionSettings src)

Creates a copy of the specified CmContentConversionSettings instance.

Parameters:

src - CmContentConversionSettings instance to copy.

Returns:

CmContentConversionSettings instance copied from src.

resume

ContentConversionResult resume(ObjectStore objStore,
                             byte[] deferralData,
                             CmContentConversionSettings outputSettings)

Checks and collects the result if the previously submitted conversion request has completed.

Parameters:

objStore - Object store where source content resides.

deferralData - identifier for previously submitted conversion request.

outputSettings - CmContentConversionSettings instance identical to what was passed to the initial convert call.

Returns:

ContentConversionResult The results of this conversion operation.