com.saperion.structures

Class DocumentInfo

java.lang.Object

com.saperion.structures.Description

com.saperion.structures.DocumentInfo

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UpdateDocumentInfo

public class DocumentInfo
extends Description

A document representation.
This object is used to set the data for a new document to be created via the SaClassicConnector.

See com.saperion.connector.SaClassicConnector#createDocument(com.saperion.structures.DocumentInfo)

Author:

tfr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Structure	structure This DocumentInfos structure.

Fields inherited from class com.saperion.structures.Description

acl, comment, ddc, metadatas

Constructor Summary

Constructors

Constructor and Description
DocumentInfo(String ddcName, Map<String,Object> metadatas, ContentStream[] content, String versionComment) Creates a new UpdateDocumentInfo.

Method Summary

Modifier and Type	Method and Description
DocumentInfo	addVariable(String name, String value) Adds a variable to this document representation.
ContentStream[]	getContent() Returns the contents of this document representation.
int	getSelectedImage()
Structure	getStructure() Returns this document representations structure.
Map<String,String>	getVariables() Returns the variables of this document representation.
void	setSelectedImage(int elementNumber)

Methods inherited from class com.saperion.structures.Description

getAcls, getDdcName, getMetadatas, getVersionComment, setAcls

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

structure

protected Structure structure

This DocumentInfos structure.

Constructor Detail

DocumentInfo

public DocumentInfo(String ddcName,
                    Map<String,Object> metadatas,
                    ContentStream[] content,
                    String versionComment)

Creates a new UpdateDocumentInfo.

Parameters:

ddcName - The name of the database definition

metadatas - The metadata of this document representation.

content - Multiple content data. If the array is empty, all content of the document will be removed. If null, the content will not be changed. Otherwise only the contained elements will be replaced.

versionComment - The comment for the version

Method Detail

setSelectedImage

public void setSelectedImage(int elementNumber)

Parameters:

elementNumber - Element to mark

getSelectedImage

public int getSelectedImage()

Returns:

Element to mark

getContent

public ContentStream[] getContent()

Returns the contents of this document representation.

Returns:

the contents of this document representation.

getVariables

public Map<String,String> getVariables()

Returns the variables of this document representation.

Returns:

the variables of this document representation.

getStructure

public Structure getStructure()

Returns this document representations structure.

Returns:

this document representations structure.

addVariable

public DocumentInfo addVariable(String name,
                                String value)

Adds a variable to this document representation.

Parameters:

name - The name of the variable.

value - The value of the variable.

Returns:

This.