com.saperion.operations

Interface Operation<T extends Serializable>

Type Parameters:

T - - The return type of the invocation of the command.

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractOperation, AcquireOwnership, AddComment, ApplyBatch, BaseOperation, CloneDocument, CountTasks, CreateDocument, CreateDocumentOperation, CreateFolder, CreateLookupEntry, CreateLookupEntryOperation, DeleteAllMediaOperation, DeleteDocument, DeleteLookupEntry, DeleteNamedMediaOperation, ExecuteStoredProcedure, FireCustomEvent, Forward, GetAccessOnLookupEntry, GetAllBoxCounts, GetAllInboxes, GetAllRunningProcesses, GetBoxCount, GetBoxCountCompleted, GetBoxCountCreated, GetBoxCountDue, GetBoxCountReminders, GetComments, GetCurrentUserInfo, GetDefinition, GetDefinitions, GetDocumentInfo, GetField, GetFields, GetInbox, GetIndexData, GetIxosDDCNames, GetLatestRevisionId, GetLookupEntryAccessControlListsOperation, GetLookupEntryOperation, GetPersonalInbox, GetProcessDefinitions, GetProcessesProperties, GetProperties, GetStreamingConfiguration, GetTaskList, GetTransitions, GetWorkflowDefinitionInitialTransition, GetWorkflowDefinitions, InTransaction, ListAdministratedTenants, ListStorageOperation, LoadDocumentById, LoadDocumentRevisionById, LoadTenantById, LoadTenantByName, LoadUserById, LoadWorkflowDefinition, ReadContentStreamPart, ReadDocumentElementContent, ReadSelectableUsersForTransition, RemoveSessionData, RevokeOwnership, SearchDocuments, SearchLookupEntriesOperation, SearchUniqueDocument, SearchUniqueLookupEntryOperation, SetCurrentUserPresent, SetCurrentUserSubstituteAccess, SetDocumentRead, SetDocumentUnread, SetUserExtensionCacheEnabled, StartWorkflowProcess, UpdateCurrentUserInformation, UpdateDocument, UpdateFolder, UpdateIndexData, UpdateLookupEntry, VoidOperation

public interface Operation<T extends Serializable>
extends Serializable

Interface for operations that will be sent by RMI. Since the code has to be executed on the Server every implementation has to be serializable.

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.
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.
T	getResult() This method will only yield a valid result after a call to invoke.
T	invoke() The method that will be called on the server side.

Method Detail

invoke

T invoke()
                              throws SaBasicException

The method that will be called on the server side.

Returns:

the result of the operation

Throws:

SaBasicException - exception when invoking this operation

afterInvoke

void afterInvoke(Object result,
               Connection connection)

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

Parameters:

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

getResult

T getResult()

This method will only yield a valid result after a call to invoke.

Returns:

The result of the command or null if the instance was not given to an invoke-call yet.

beforeInvoke

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

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().

Parameters:

token - session token

connection - the connection the operation is invoked on

Throws:

SaAuthenticationException

SaSystemException