com.softwareag.mobile.runtime.toolkit.operations

Class AbstractSynchronizableOperation

java.lang.Object

com.softwareag.mobile.runtime.toolkit.operations.AbstractSynchronizableOperation

All Implemented Interfaces:

IOperation

Direct Known Subclasses:

AbstractRestOperation, AbstractThreadedOperation, FileLoadOperation

public abstract class AbstractSynchronizableOperation
extends java.lang.Object
implements IOperation

The AbstractSynchronizableOperation implements all necessary members from it's super class IOperation and provides the possibility to notify all registered listeners in a thread-safe manner.

All delegates will be called from the thread, which creates this operation. So the execution itself can run asynchronously. To reach this goal, the operation holds an internally created nUIObject and fires events by using nUIController.eventListenerQueue(nUIObject, int).

The execute() method can be influenced by the usage of an IOperationCacheHandler which provides methods to hook into the execution. Furthermore the IOperationCacheHandler is an IOperationDelegate and it is called as the first delegate in notifyOperationFailed() and notifyOperationFinished().

Subclasses must call fireEvent(int) to synchronized notify all delegates. Possible arguments are OperationNotifier.FINISHED and OperationNotifier.FAILED correspondent to the methods described by IOperationDelegate.

Subclasses must override internalExecute().

Version:

10.1.0.0000-0462

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPERATION_FAILED
static int	OPERATION_SUCCESSFUL

Constructor Summary

Constructors

Constructor and Description
AbstractSynchronizableOperation()

Method Summary

Modifier and Type	Method and Description
void	addOperationDelegate(IOperationDelegate delegate) Adds the delivered IOperationDelegate.
void	execute() Executes this operation.
byte[]	getRawResult() Returns the result as an byte-array.
com.softwareag.mobile.runtime.comms.Response	getResponse()
java.lang.String	getResult() Returns the result as a String.
java.lang.String	getResult(java.lang.String encoding) Returns the result as a String with s specific encoding.
int	getResultCode() Returns the resultCode as an int-value.
void	removeOperationDelegate(IOperationDelegate delegate) Removes the delivered IOperationDelegate.
void	setCacheHandler(IOperationCacheHandler cacheHandler) Sets the IOperationCacheHandler that should be used for this operation.
void	setResponse(com.softwareag.mobile.runtime.comms.Response resp)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_SUCCESSFUL

public static final int OPERATION_SUCCESSFUL

See Also:

Constant Field Values

OPERATION_FAILED

public static final int OPERATION_FAILED

See Also:

Constant Field Values

Constructor Detail

AbstractSynchronizableOperation

public AbstractSynchronizableOperation()

Method Detail

getResultCode

public final int getResultCode()

Description copied from interface: IOperation

Returns the resultCode as an int-value.

Specified by:

getResultCode in interface IOperation

execute

public void execute()

Description copied from interface: IOperation

Executes this operation.

Specified by:

execute in interface IOperation

setCacheHandler

public void setCacheHandler(IOperationCacheHandler cacheHandler)

Sets the IOperationCacheHandler that should be used for this operation.

getResult

public final java.lang.String getResult()

Description copied from interface: IOperation

Returns the result as a String.
Transforms get byte-result from IOperation.getRawResult() into a String by using UTF-8 as encoding. Call IOperation.getResult(String) under the hood.

Specified by:

getResult in interface IOperation

See Also:

IOperation.getResult(String)

getResult

public final java.lang.String getResult(java.lang.String encoding)
                                 throws java.io.UnsupportedEncodingException

Description copied from interface: IOperation

Returns the result as a String with s specific encoding.

Specified by:

getResult in interface IOperation

Throws:

java.io.UnsupportedEncodingException

getRawResult

public byte[] getRawResult()

Description copied from interface: IOperation

Returns the result as an byte-array.

Specified by:

getRawResult in interface IOperation

addOperationDelegate

public void addOperationDelegate(IOperationDelegate delegate)

Description copied from interface: IOperation

Adds the delivered IOperationDelegate. If the same IOperationDelegate is already added, it will not be added again.

Specified by:

addOperationDelegate in interface IOperation

removeOperationDelegate

public void removeOperationDelegate(IOperationDelegate delegate)

Description copied from interface: IOperation

Removes the delivered IOperationDelegate.

Specified by:

removeOperationDelegate in interface IOperation

getResponse

public com.softwareag.mobile.runtime.comms.Response getResponse()

Specified by:

getResponse in interface IOperation

Returns:

the Response object for this operation

setResponse

public void setResponse(com.softwareag.mobile.runtime.comms.Response resp)