com.saperion.intf

Interface SaDocInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

SaDocInfoImpl

public interface SaDocInfo
extends Serializable

Interface of document info.
Holds information about a document like the document Hdoc, who created the document and a map of the elements of the document.

Author:

rbo

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SaDocInfo.ElementInfo Document element info.
static class	SaDocInfo.ElementType Element types from backend.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCreateUser()
int	getElementCount()
List<SaDocInfo.ElementInfo>	getElementInfo()
SaDocInfo.ElementInfo	getElementInfo(int elementNumber) Returns the element info by the given element number, if existing.
Map<Integer,SaDocInfo.ElementInfo>	getElementInfoMap() Returns the element info objects as a map with the corresponding element number as key.
String	getHdoc()
Properties	getVariableData()
boolean	hasAnnotations()

Method Detail

getVariableData

Properties getVariableData()

Returns:

Document variable data

getElementInfo

List<SaDocInfo.ElementInfo> getElementInfo()

Returns:

Element informations

getElementInfoMap

Map<Integer,SaDocInfo.ElementInfo> getElementInfoMap()

Returns the element info objects as a map with the corresponding element number as key.

Returns:

the element information objects as a map.

getElementInfo

SaDocInfo.ElementInfo getElementInfo(int elementNumber)

Returns the element info by the given element number, if existing. Null is returned if no document info is existing for the given element number.

Parameters:

elementNumber - The element number to get the document info from.

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:

Wether there is annotated content in this document.

getHdoc

String getHdoc()

Returns:

hDoc of the revision represented by this SaDocInfo instance