Skip navigation links

com.stellent.cis.client.api.scs.file
Interface ISCSConvertedFileInfo

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSFileInfo, ISCSFileRetrievalInfo, ISCSObject, java.io.Serializable

public interface ISCSConvertedFileInfo

extends ISCSFileInfo, ISCSFileRetrievalInfo

Info bean to hold information regarding a dynamic conversion call.

Nested Class Summary

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

Fields inherited from interface com.stellent.cis.client.api.scs.file.ISCSFileInfo

RENDITION_ALTERNATE, RENDITION_PRIMARY, RENDITION_WEB, REVISION_LATEST, REVISION_LATEST_RELEASED

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.lang.String	getConversionLayout()
java.lang.String	getConversionRule()
java.lang.String	getConversionTemplate()
java.lang.String	getViewFormat()
boolean	isAlternate()
boolean	isUseDocCache()
void	setAlternate(boolean alternate) Set the alternate flag
void	setConversionLayout(java.lang.String conversionLayout) Set the conversion layout to use
void	setConversionRule(java.lang.String rule) Set the conversion rule to use
void	setConversionTemplate(java.lang.String template) Set the conversion template
void	setUseDocCache(boolean useDocCache) Set the document cache flag
void	setViewFormat(java.lang.String format) Set the view format

Methods inherited from interface com.stellent.cis.client.api.scs.file.ISCSFileInfo

getRendition, getRevisionSelectionMethod, setRendition, setRevisionSelectionMethod

Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject

castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Methods inherited from interface com.stellent.cis.client.api.scs.file.ISCSFileRetrievalInfo

getPageNumber, isValidateContent, setPageNumber, setValidateContent

Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject

castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Method Detail

getConversionTemplate

java.lang.String getConversionTemplate()

Returns:

the conversion template

setConversionTemplate

void setConversionTemplate(java.lang.String template)

Set the conversion template

Parameters:

template - the template contentID

getConversionLayout

java.lang.String getConversionLayout()

Returns:

the conversion layout to use

setConversionLayout

void setConversionLayout(java.lang.String conversionLayout)

Set the conversion layout to use

Parameters:

conversionLayout - the conversion layout contentID

getViewFormat

java.lang.String getViewFormat()

Returns:

the file to be converted and displayed, Native or WebViewable

setViewFormat

void setViewFormat(java.lang.String format)

Set the view format

Parameters:

format - the format of the file to be converted, Native or WebViewable

isAlternate

boolean isAlternate()

Returns:

Specifies that the alternate file should be converted and displayed rather than the primary file

setAlternate

void setAlternate(boolean alternate)

Set the alternate flag

Parameters:

alternate - if true, the alternate file should be converted and displayed

isUseDocCache

boolean isUseDocCache()

Returns:

disables the caching mechanism while requesting an individual content item. It applies only to the single request

setUseDocCache

void setUseDocCache(boolean useDocCache)

Set the document cache flag

Parameters:

useDocCache - set to true, caching will be disabled while requesting an individual content item

getConversionRule

java.lang.String getConversionRule()

Returns:

the conversion rule to be used, rather than allowing the conversion rule to be selected by the conversion rule criteria

setConversionRule

void setConversionRule(java.lang.String rule)

Set the conversion rule to use

Parameters:

rule - the rule to use for conversion

Skip navigation links