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
com.lexmark.saperion.document.DocumentElementStoreInformationType	appendChild(com.lexmark.saperion.document.DocumentElementType element) This method appends a given document element as a child to the current one.
void	delete() This method deletes the current document element.
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.
default InputStream	renderContent(com.lexmark.saperion.document.RenditionType renditionType) This method render the content of the given element into given type with given options and return as InputStream
InputStream	renderContent(com.lexmark.saperion.document.RenditionType renditionType, com.lexmark.saperion.document.RenderOption... renderOptions) This method render the content of the given element into given type with given options and return as InputStream
com.lexmark.saperion.document.DocumentElementStoreInformationType	update(com.lexmark.saperion.document.DocumentElementType element) This method updates the document element instance and replaces it with the given entity.

Method Detail

update

com.lexmark.saperion.document.DocumentElementStoreInformationType update(com.lexmark.saperion.document.DocumentElementType element)
                                                                  throws com.lexmark.saperion.exceptions.EcmException

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

Parameters:

element - the update document element input

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

appendChild

com.lexmark.saperion.document.DocumentElementStoreInformationType appendChild(com.lexmark.saperion.document.DocumentElementType element)
                                                                       throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException

loadContent

InputStream loadContent()
                 throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

renderContent

default InputStream renderContent(com.lexmark.saperion.document.RenditionType renditionType)
                           throws com.lexmark.saperion.exceptions.EcmException

This method render the content of the given element into given type with given options and return as InputStream

Parameters:

renditionType -

Returns:

Throws:

com.lexmark.saperion.exceptions.EcmException

renderContent

InputStream renderContent(com.lexmark.saperion.document.RenditionType renditionType,
                          com.lexmark.saperion.document.RenderOption... renderOptions)
                   throws com.lexmark.saperion.exceptions.EcmException

This method render the content of the given element into given type with given options and return as InputStream

Parameters:

renditionType -

renderOptions -

Returns:

An instance of InputStream

Throws:

com.lexmark.saperion.exceptions.EcmException

delete

void delete()
     throws com.lexmark.saperion.exceptions.EcmException

This method deletes the current document element.

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred