com.saperion.operations.document

Class ReadDocumentElementContent

java.lang.Object

com.saperion.operations.BaseOperation<T>

com.saperion.operations.AbstractOperation<RemoteContentInputStreamDescriptor>

com.saperion.operations.document.ReadDocumentElementContent

All Implemented Interfaces:

Operation<RemoteContentInputStreamDescriptor>, Serializable

public class ReadDocumentElementContent
extends AbstractOperation<RemoteContentInputStreamDescriptor>

An Operation that returns a session data key to an input stream containing the content of a ContentDocumentElementType given its id.

Author:

jschwarz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReadDocumentElementContent(com.lexmark.saperion.document.DocumentReferenceType documentId, com.lexmark.saperion.document.DocumentElementReferenceType documentElementId) This creates a new operation that initiates streaming of document content: It opens the documents stream - or streams in case its chunked - on the server side and registers them as closable at the current session.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterInvoke(Object result, Connection connection) This method will be called on the client side e.g.
RemoteContentInputStreamDescriptor	invoke() The method that will be called on the server side.

Methods inherited from class com.saperion.operations.AbstractOperation

getResult, toArrayList, toString

Methods inherited from class com.saperion.operations.BaseOperation

beforeInvoke, getClientToken, mapException

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadDocumentElementContent

public ReadDocumentElementContent(com.lexmark.saperion.document.DocumentReferenceType documentId,
                          com.lexmark.saperion.document.DocumentElementReferenceType documentElementId)

This creates a new operation that initiates streaming of document content:

It opens the documents stream - or streams in case its chunked - on the server side and registers them as closable at the current session. It then returns a RemoteContentInputStreamDescriptor from which a remote stream can be created. If the given id belongs to a document element with the type DocumentNodeType.LINK or DocumentNodeType.STRUCTURE that is not a chunked document element an empty input stream will be returned.

Parameters:

documentId - The id of the document the element to read from belongs to. Must not be null.

documentElementId - The id of the document element to read from. Must not be null.

Method Detail

invoke

public RemoteContentInputStreamDescriptor invoke()
                                          throws SaBasicException

Description copied from interface: Operation

The method that will be called on the server side.

Returns:

the result of the operation

Throws:

SaBasicException - exception when invoking this operation

afterInvoke

public void afterInvoke(Object result,
               Connection connection)

Description copied from interface: Operation

This method will be called on the client side e.g. to assign the result.

Specified by:

afterInvoke in interface Operation<RemoteContentInputStreamDescriptor>

Overrides:

afterInvoke in class AbstractOperation<RemoteContentInputStreamDescriptor>

Parameters:

result - The result of invoke obtained by the rmi-call