com.saperion.intf

Interface SaDocInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

SaDocInfoImpl

public interface SaDocInfo
extends Serializable

Holds information about a document like the document's structure and variables read from the archive.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SaDocInfo.ElementInfo Represents an element of a document's structure.
static class	SaDocInfo.ElementType Structure-element types.

Method Summary

Modifier and Type	Method and Description
int	getCreateUser()
int	getElementCount()
List<SaDocInfo.ElementInfo>	getElementInfo() Returns a list of the structure-elements of this document.
SaDocInfo.ElementInfo	getElementInfo(int elementNumber) Returns the element info of the element with the specified number, if existing.
Map<Integer,SaDocInfo.ElementInfo>	getElementInfoMap() Returns the structure-elements as a map with the corresponding element number as key.
String	getHdoc()
Properties	getVariableData() Returns variables of the document.
boolean	hasAnnotations()

Method Detail

getVariableData

Properties getVariableData()

Returns variables of the document. Use SaDocInfo.ElementInfo.getVariableData() to get variables contained in a specific element.

Returns:

Document variable data

getElementInfo

List<SaDocInfo.ElementInfo> getElementInfo()

Returns a list of the structure-elements of this document.

Returns:

Element information

getElementInfoMap

Map<Integer,SaDocInfo.ElementInfo> getElementInfoMap()

Returns the structure-elements as a map with the corresponding element number as key.

Returns:

the element information as a map.

getElementInfo

SaDocInfo.ElementInfo getElementInfo(int elementNumber)

Returns the element info of the element with the specified number, if existing. Null is returned if no element-info is existing for the given element number.

Parameters:

elementNumber - The element number to get information for

Returns:

the document info for the given element number, if existing - null otherwise.

getElementCount

int getElementCount()

Returns:

Element count

getCreateUser

int getCreateUser()

Returns:

Document create user

hasAnnotations

boolean hasAnnotations()

Returns:

true if the document contains annotations

getHdoc

String getHdoc()

Returns:

hDoc of the revision represented by this SaDocInfo instance