com.saperion.intf

Interface SaDocInfo.ElementInfo

All Superinterfaces:

Serializable

Enclosing interface:

SaDocInfo

public static interface SaDocInfo.ElementInfo
extends Serializable

Document element info.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDocUid()
String	getFileName() Deprecated. Since 7.1 SP1 use getName() or getFullName() instead
int	getFrameCount()
String	getFullName() Returns the full name of the element as it was stored in the archive (with page-numbers for multi-page-tiffs but without path).
String	getLinkUid()
String	getName() Returns only the name of the element.
int	getNumber()
int	getPageCount()
long	getSize()
int	getStructureLevel()
SaDocInfo.ElementType	getType()
Properties	getVariableData()
boolean	isSelected()

Method Detail

getNumber

int getNumber()

Returns:

Number of element

getFileName

@Deprecated
String getFileName()

Deprecated. Since 7.1 SP1 use getName() or getFullName() instead

Returns:

Element filename

getFullName

String getFullName()

Returns the full name of the element as it was stored in the archive (with page-numbers for multi-page-tiffs but without path).

Returns:

full name of the element

getName

String getName()

Returns only the name of the element. For multi-page tiffs, the page number will be removed.

Returns:

Element name

getType

SaDocInfo.ElementType getType()

Returns:

Element type

isSelected

boolean isSelected()

Returns:

True, if selected

getVariableData

Properties getVariableData()

Returns:

element variable data

getSize

long getSize()

Returns:

element's size

getPageCount

int getPageCount()

Returns:

the number of pages

getFrameCount

int getFrameCount()

Returns:

the number of frames

getDocUid

String getDocUid()

Returns:

the uid of the document

getLinkUid

String getLinkUid()

Returns:

the uid of the linked document if the document is a link.

getStructureLevel

int getStructureLevel()

Returns:

the element's level in the structure hierarchy. 0 indicates unstructured document.