Skip navigation links

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

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSObject, java.io.Serializable

public interface ISCSConvertedDisplayInfo

extends ISCSObject

Used to pass information to the ISCSFileAPI.getDynamicConversion(com.stellent.cis.client.api.scs.context.ISCSContext, com.stellent.cis.client.api.scs.ISCSDocumentID) and ISCSFileAPI.getDynamicFile(com.stellent.cis.client.api.scs.context.ISCSContext, java.lang.String) methods to specify information regarding the rewriting of the converted URLs in the returned HTML.

Nested Class Summary

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.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.lang.String	getFileEncoding()
java.util.Map	getImageUrlParameters()
java.lang.String	getImageUrlParametersEncoded()
java.util.Map	getPageUrlParameters()
java.lang.String	getPageUrlParametersEncoded()
java.lang.String	getUrlContext()
boolean	isForceClientEncoding()
boolean	isRewriteForDisplay()
boolean	isShowEncodingInHeader()
void	setFileEncoding(java.lang.String encoding) Used when isRewriteForDisplay() is set, specifies the encoding of the file.
void	setForceClientEncoding(boolean forceClientEncoding) Sets the forceClientEncoding flag
void	setImageUrlParameters(java.util.Map parameters) URL Parameters that will be added to the url
void	setPageUrlParameters(java.util.Map parameters) URL Parameters that will be added to the url for links between pages
void	setRewriteForDisplay(boolean rewriteForDisplay) Set the rewrite for display flag
void	setShowEncodingInHeader(boolean showEncodingInHeader) Sets the showEncodingInHeader flag
void	setUrlContext(java.lang.String urlContext)

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

isRewriteForDisplay

boolean isRewriteForDisplay()

Returns:

if true, the urls will be rewritten for display

setRewriteForDisplay

void setRewriteForDisplay(boolean rewriteForDisplay)

Set the rewrite for display flag

Parameters:

rewriteForDisplay - set to true if the urls will be rewritten for display, false otherwise

isShowEncodingInHeader

boolean isShowEncodingInHeader()

Returns:

if true, then Content Server will add the name of the encoding to the response

setShowEncodingInHeader

void setShowEncodingInHeader(boolean showEncodingInHeader)

Sets the showEncodingInHeader flag

Parameters:

showEncodingInHeader - set to true the Content Server will add the name of the encoding to the response

isForceClientEncoding

boolean isForceClientEncoding()

Returns:

if true, then Content Server write the response back using the client's encoding as opposed to using Content Server's encoding

setForceClientEncoding

void setForceClientEncoding(boolean forceClientEncoding)

Sets the forceClientEncoding flag

Parameters:

forceClientEncoding - set to true to force the Content Server to write the response back using the client's encoding

setImageUrlParameters

void setImageUrlParameters(java.util.Map parameters)

URL Parameters that will be added to the url

Parameters:

parameters - a mapping of String name to String value of URL parameters that will be added to the rewritten URL; valid only if isRewriteForDisplay() is enabled

getImageUrlParameters

java.util.Map getImageUrlParameters()

Returns:

the mapping of URL parameters

getImageUrlParametersEncoded

java.lang.String getImageUrlParametersEncoded()

Returns:

the URL parameters in URL-encoded format

setPageUrlParameters

void setPageUrlParameters(java.util.Map parameters)

URL Parameters that will be added to the url for links between pages

Parameters:

parameters - a mapping of String name to String value of URL parameters that will be added to the rewritten URL; valid only if isRewriteForDisplay() is enabled

getPageUrlParameters

java.util.Map getPageUrlParameters()

Returns:

the mapping of URL parameters for links between pages

getPageUrlParametersEncoded

java.lang.String getPageUrlParametersEncoded()

Returns:

the URL parameters in URL-encoded format for links between pages

setFileEncoding

void setFileEncoding(java.lang.String encoding)

Used when isRewriteForDisplay() is set, specifies the encoding of the file. If not set, the system will attempt to determine the encoding to use by looking for a <meta http-equiv="Content-Type" tag in the HTML file. If not found, the default file system encoding is used.

Parameters:

encoding - the encoding to use, overwrites any discovery of encoding

getFileEncoding

java.lang.String getFileEncoding()

Returns:

the file encoding of the HTML file; null to use default mechanism

See Also:

setFileEncoding(String)

getUrlContext

java.lang.String getUrlContext()

Returns:

the context to use for the URL; if not set, the IContext.getContextPath() is used from the corresponding ISCSContext object

setUrlContext

void setUrlContext(java.lang.String urlContext)

Parameters:

urlContext - the url context (i.e. the url prefix upto the servlet declaration)

Skip navigation links