com.saperion.operations.document

Class LoadDocumentById

java.lang.Object

com.saperion.operations.BaseOperation<T>

com.saperion.operations.AbstractOperation<com.lexmark.saperion.document.DocumentRevisionType>

com.saperion.operations.document.LoadDocumentById

All Implemented Interfaces:

Operation<com.lexmark.saperion.document.DocumentRevisionType>, Serializable

public class LoadDocumentById
extends AbstractOperation<com.lexmark.saperion.document.DocumentRevisionType>
implements Operation<com.lexmark.saperion.document.DocumentRevisionType>

The operation LoadDocumentById loads a document from the backend by its id.

Author:

jschwarz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoadDocumentById(com.lexmark.saperion.document.DocumentReferenceType id) This creates an operation that completely loads the latest revision of the document with the given id.
LoadDocumentById(com.lexmark.saperion.document.DocumentReferenceType id, com.lexmark.saperion.document.LoadKindEnumeration loadKind) This creates an operation that loads the latest revision of the document with the given id.

Method Summary

Methods

Modifier and Type	Method and Description
com.lexmark.saperion.document.DocumentReferenceType	getId()
com.lexmark.saperion.document.LoadKindEnumeration	getLoadKind()
com.lexmark.saperion.document.DocumentRevisionType	invoke() The method that will be called on the server side.
String	toString()

Methods inherited from class com.saperion.operations.AbstractOperation

afterInvoke, getResult, toArrayList

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

Methods inherited from interface com.saperion.operations.Operation

afterInvoke, beforeInvoke, getResult

Constructor Detail

LoadDocumentById

public LoadDocumentById(com.lexmark.saperion.document.DocumentReferenceType id)

This creates an operation that completely loads the latest revision of the document with the given id.

Parameters:

id - the id of the document to load. Must not be null.

LoadDocumentById

public LoadDocumentById(com.lexmark.saperion.document.DocumentReferenceType id,
                com.lexmark.saperion.document.LoadKindEnumeration loadKind)

This creates an operation that loads the latest revision of the document with the given id.

Parameters:

id - the id of the document to load. Must not be null.

loadKind - Whether the document should be loaded completely or without the content. Must not be null.

Method Detail

invoke

public com.lexmark.saperion.document.DocumentRevisionType invoke()
                                                          throws SaBasicException

Description copied from interface: Operation

The method that will be called on the server side.

Specified by:

invoke in interface Operation<com.lexmark.saperion.document.DocumentRevisionType>

Returns:

the result of the operation

Throws:

SaBasicException - exception when invoking this operation

toString

public String toString()

Overrides:

toString in class AbstractOperation<com.lexmark.saperion.document.DocumentRevisionType>

getId

public com.lexmark.saperion.document.DocumentReferenceType getId()

getLoadKind

public com.lexmark.saperion.document.LoadKindEnumeration getLoadKind()