com.stellent.cis.client.api.scs.component.cis
Interface ISCSFileLocation

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSObject, java.io.Serializable

public interface ISCSFileLocation
extends ISCSObject

Information about file locations in the content server

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	getLocationType()
java.lang.String	getMD5()
java.lang.String	getRelativePath()
java.lang.String	getServerRoot()
java.lang.String	getVaultRoot()
java.lang.String	getWeblayoutRoot()
boolean	isRootFile()
boolean	isVaultFile()
boolean	isWeblayoutFile()

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

getRelativePath

java.lang.String getRelativePath()

Returns:

the relative path to the file on the content server file system

getServerRoot

java.lang.String getServerRoot()

Returns:

the root directory

getWeblayoutRoot

java.lang.String getWeblayoutRoot()

Returns:

the weblayout root directory

getVaultRoot

java.lang.String getVaultRoot()

Returns:

the vault root directory

getLocationType

java.lang.String getLocationType()

Returns:

the type of location for this file (i.e. "vault", "weblayout", or "root"); the type determines which is the parent of the file; that is, the file is a relative to the corresponding root

isWeblayoutFile

boolean isWeblayoutFile()

Returns:

true if the getLocationType() is "weblayout"

isVaultFile

boolean isVaultFile()

Returns:

true if the getLocationType() is "vault"

isRootFile

boolean isRootFile()

Returns:

true if the getLocationType() is "root"

getMD5

java.lang.String getMD5()

Returns:

the MD5 checksum value; only available if the flag to generate the checksum was passed into the method