com.lexmark.saperion.client.document

Interface DocumentElementClient

All Known Implementing Classes:

DocumentElementClientImpl

public interface DocumentElementClient

This client provides functionality concerning an individual element of a given document.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	appendChild(DocumentElementType element) This method appends a given document element as a child to the current one.
InputStream	loadContent() This method Opens the content of the document element identified by the given id for reading and returns an input stream for that data.
void	update(DocumentElementType element) This method updates the document element instance and replaces it with the given entity.

Method Detail

update

void update(DocumentElementType element)
     throws EcmException

This method updates the document element instance and replaces it with the given entity.

Parameters:

element - the update document element input

Throws:

EcmException - indicates that a system exception occurred

appendChild

void appendChild(DocumentElementType element)
          throws EcmException

This method appends a given document element as a child to the current one. This method is only valid for structure composite document elements.

Parameters:

element - the element to append

Throws:

EcmException

loadContent

InputStream loadContent()
                 throws EcmException

This method Opens the content of the document element identified by the given id for reading and returns an input stream for that data. If the element is chunked the resulting stream will stream over all the chunks.

Returns:

an input stream for the content of the given document element

Throws:

EcmException - indicates that a system exception occurred