com.saperion.operations.document

Class CreateDocumentOperation

java.lang.Object

com.saperion.operations.BaseOperation<T>

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

com.saperion.operations.document.CreateDocumentOperation

All Implemented Interfaces:

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

public class CreateDocumentOperation
extends AbstractOperation<com.lexmark.saperion.document.DocumentStoreInformationType>

This Operation stores a new document in the system.

Author:

jschwarz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateDocumentOperation(com.lexmark.saperion.document.DocumentDefinitionReferenceType definition, Map<String,Object> indexData, com.lexmark.saperion.document.DocumentElementType rootElement)

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeInvoke(int token, Connection connection) This method will be called on the client-side to prepare an operation for invocation on the server-side.
com.lexmark.saperion.document.DocumentStoreInformationType	invoke() The method that will be called on the server side.

Methods inherited from class com.saperion.operations.AbstractOperation

afterInvoke, getResult, toArrayList, toString

Methods inherited from class com.saperion.operations.BaseOperation

getClientToken, mapException

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateDocumentOperation

public CreateDocumentOperation(com.lexmark.saperion.document.DocumentDefinitionReferenceType definition,
                       Map<String,Object> indexData,
                       com.lexmark.saperion.document.DocumentElementType rootElement)

Method Detail

beforeInvoke

public void beforeInvoke(int token,
                Connection connection)
                  throws SaAuthenticationException,
                         SaSystemException

Description copied from interface: Operation

This method will be called on the client-side to prepare an operation for invocation on the server-side. Implementations can use this method to perform any preparation tasks that require the current session-token. A default-implementation that just stores the token is provided by BaseOperation. The token can be retrieved by BaseOperation.getClientToken().

Specified by:

beforeInvoke in interface Operation<com.lexmark.saperion.document.DocumentStoreInformationType>

Overrides:

beforeInvoke in class BaseOperation<com.lexmark.saperion.document.DocumentStoreInformationType>

Parameters:

token - session token

connection - the connection the operation is invoked on

Throws:

SaAuthenticationException

SaSystemException

invoke

public com.lexmark.saperion.document.DocumentStoreInformationType 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