LoadDocumentById (JCS Classic Connector Module 8.6.0-7 API)

java.lang.Object
- com.lexmark.saperion.remote.common.operations.AbstractOperation<T,SaBasicException,LegacyConnection>
- - com.saperion.operations.LegacyOperation<com.lexmark.saperion.document.DocumentRevisionType>
  - - com.saperion.operations.document.LoadDocumentById

All Implemented Interfaces:

com.lexmark.saperion.remote.common.operations.Operation<com.lexmark.saperion.document.DocumentRevisionType,SaBasicException,LegacyConnection>, java.io.Serializable
```
public class LoadDocumentById
extends LegacyOperation<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	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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.lexmark.saperion.document.DocumentReferenceType`	`getId()`
`com.lexmark.saperion.document.LoadKindEnumeration`	`getLoadKind()`
`com.lexmark.saperion.document.DocumentRevisionType`	`invoke()`
`java.lang.String`	`toString()`

Methods inherited from class com.saperion.operations.LegacyOperation
beforeInvoke, beforeInvoke, getClientToken, mapEcmException, mapException

Methods inherited from class com.lexmark.saperion.remote.common.operations.AbstractOperation
afterInvoke, getResult, toArrayList, toCaseInsensitiveMap, toHashMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.lexmark.saperion.remote.common.operations.Operation
audit, dispatchEvent, isAuditable, isEventDispatcher

- 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
```
    Throws:
    
    SaBasicException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class com.lexmark.saperion.remote.common.operations.AbstractOperation<com.lexmark.saperion.document.DocumentRevisionType,SaBasicException,LegacyConnection>
  - getId
```
public com.lexmark.saperion.document.DocumentReferenceType getId()
```
  - getLoadKind
```
public com.lexmark.saperion.document.LoadKindEnumeration getLoadKind()
```