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

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSObject, java.io.Serializable

All Known Subinterfaces:

ISCSConvertedFileInfo

public interface ISCSFileRetrievalInfo
extends ISCSObject

Retrieval options for dynamic files

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	getPageNumber()
boolean	isValidateContent()
void	setPageNumber(java.lang.String pageNumber) Set the page number to retrieve
void	setValidateContent(boolean validate)

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

isValidateContent

boolean isValidateContent()

Returns:

the status if the validate content flag. If true, the dynamic conversion first validates the document exists and can be converted. If there is an error, an exception will be thrown. Note: this will require two round trips to the content server if set, the default is false

setValidateContent

void setValidateContent(boolean validate)

Parameters:

validate - the validate content flag

See Also:

isValidateContent()

getPageNumber

java.lang.String getPageNumber()

Returns:

the page number of the dynamic converter result to return

setPageNumber

void setPageNumber(java.lang.String pageNumber)

Set the page number to retrieve

Parameters:

pageNumber - the page number