IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.services.wosa
Interface WOSADeviceServiceInterface

All Known Implementing Classes:
WOSADeviceService

public interface WOSADeviceServiceInterface

The WOSADeviceServiceInterface is implemented by the WOSA services. All VTF services that are bound to a WOSA/XFS device must extend or use this interface.


Field Summary
static int JNI_BAD_INSTANCE
           
static int JNI_END_THREAD
           
static int JNI_UNKNOWN_INSTANCE
           
static int WFS_CLOSE_COMPLETE
           
static int WFS_DEREGISTER_COMPLETE
           
static int WFS_EXECUTE_COMPLETE
           
static int WFS_EXECUTE_EVENT
           
static int WFS_GETINFO_COMPLETE
           
static int WFS_INDEFINITE_WAIT
           
static int WFS_LOCK_COMPLETE
           
static int WFS_OPEN_COMPLETE
           
static int WFS_REGISTER_COMPLETE
           
static int WFS_SERVICE_EVENT
           
static int WFS_SUCCESS
           
static int WFS_SYSE_APP_DISCONNECT
           
static int WFS_SYSE_DEVICE_STATUS
           
static int WFS_SYSE_HARDWARE_ERROR
           
static int WFS_SYSE_UNDELIVERABLE_MSG
           
static int WFS_SYSE_VERSION_ERROR
           
static int WFS_SYSTEM_EVENT
           
static int WFS_TIMER_EVENT
           
static int WFS_UNLOCK_COMPLETE
           
static int WFS_USER_EVENT
           
static int WM_USER
           
 
Method Summary
 WOSAResult cancelCmd()
          Cancels all pending asynchronous requests.
 WOSAResult cancelCmd(int requestId)
          Cancels the specified pending asynchronous request.
 int cleanup()
          Releases the WOSADevice resources.
 WOSAResult close()
          Closes the device session.
 WOSAResult execute(WOSAMessageRequest cmd)
          Sends a command to the device.
 WOSAResult getInfo(WOSAMessageRequest info)
          Retrieves information from the device.
 WOSAResult lock()
          Locks the device for the exclusive use of the current WOSADevice instance.
 WOSAResult open()
          Opens the device and establishes a session with it.
 int startup()
          Initializes the WOSADevice instance.
 WOSAResult unlock()
          Releases the device previously locked.
 

Field Detail

WFS_SUCCESS

public static final int WFS_SUCCESS
See Also:
Constant Field Values

WFS_INDEFINITE_WAIT

public static final int WFS_INDEFINITE_WAIT
See Also:
Constant Field Values

WM_USER

public static final int WM_USER
See Also:
Constant Field Values

WFS_OPEN_COMPLETE

public static final int WFS_OPEN_COMPLETE
See Also:
Constant Field Values

WFS_CLOSE_COMPLETE

public static final int WFS_CLOSE_COMPLETE
See Also:
Constant Field Values

WFS_LOCK_COMPLETE

public static final int WFS_LOCK_COMPLETE
See Also:
Constant Field Values

WFS_UNLOCK_COMPLETE

public static final int WFS_UNLOCK_COMPLETE
See Also:
Constant Field Values

WFS_REGISTER_COMPLETE

public static final int WFS_REGISTER_COMPLETE
See Also:
Constant Field Values

WFS_DEREGISTER_COMPLETE

public static final int WFS_DEREGISTER_COMPLETE
See Also:
Constant Field Values

WFS_GETINFO_COMPLETE

public static final int WFS_GETINFO_COMPLETE
See Also:
Constant Field Values

WFS_EXECUTE_COMPLETE

public static final int WFS_EXECUTE_COMPLETE
See Also:
Constant Field Values

WFS_EXECUTE_EVENT

public static final int WFS_EXECUTE_EVENT
See Also:
Constant Field Values

WFS_SERVICE_EVENT

public static final int WFS_SERVICE_EVENT
See Also:
Constant Field Values

WFS_USER_EVENT

public static final int WFS_USER_EVENT
See Also:
Constant Field Values

WFS_SYSTEM_EVENT

public static final int WFS_SYSTEM_EVENT
See Also:
Constant Field Values

WFS_TIMER_EVENT

public static final int WFS_TIMER_EVENT
See Also:
Constant Field Values

JNI_END_THREAD

public static final int JNI_END_THREAD
See Also:
Constant Field Values

JNI_BAD_INSTANCE

public static final int JNI_BAD_INSTANCE
See Also:
Constant Field Values

JNI_UNKNOWN_INSTANCE

public static final int JNI_UNKNOWN_INSTANCE
See Also:
Constant Field Values

WFS_SYSE_UNDELIVERABLE_MSG

public static final int WFS_SYSE_UNDELIVERABLE_MSG
See Also:
Constant Field Values

WFS_SYSE_HARDWARE_ERROR

public static final int WFS_SYSE_HARDWARE_ERROR
See Also:
Constant Field Values

WFS_SYSE_VERSION_ERROR

public static final int WFS_SYSE_VERSION_ERROR
See Also:
Constant Field Values

WFS_SYSE_DEVICE_STATUS

public static final int WFS_SYSE_DEVICE_STATUS
See Also:
Constant Field Values

WFS_SYSE_APP_DISCONNECT

public static final int WFS_SYSE_APP_DISCONNECT
See Also:
Constant Field Values
Method Detail

cancelCmd

public WOSAResult cancelCmd()
Cancels all pending asynchronous requests.

Returns:
com.ibm.dse.services.wosa.WOSAResult

cancelCmd

public WOSAResult cancelCmd(int requestId)
Cancels the specified pending asynchronous request.

Parameters:
requestId - int
Returns:
com.ibm.dse.services.wosa.WOSAResult

cleanup

public int cleanup()
Releases the WOSADevice resources.

Returns:
int

close

public WOSAResult close()
Closes the device session.

Returns:
com.ibm.dse.services.wosa.WOSAResult

execute

public WOSAResult execute(WOSAMessageRequest cmd)
Sends a command to the device.

Parameters:
cmd - com.ibm.dse.services.wosa.WOSAMessageRequest
Returns:
com.ibm.dse.services.wosa.WOSAResult

getInfo

public WOSAResult getInfo(WOSAMessageRequest info)
Retrieves information from the device.

Parameters:
info - com.ibm.dse.services.wosa.WOSAMessageRequest
Returns:
com.ibm.dse.services.wosa.WOSAResult

lock

public WOSAResult lock()
Locks the device for the exclusive use of the current WOSADevice instance.

Returns:
com.ibm.dse.services.wosa.WOSAResult

open

public WOSAResult open()
Opens the device and establishes a session with it.

Returns:
com.ibm.dse.services.wosa.WOSAResult

startup

public int startup()
            throws DSEDLLNotFoundException
Initializes the WOSADevice instance.

Returns:
int
Throws:
DSEDLLNotFoundException

unlock

public WOSAResult unlock()
Releases the device previously locked.

Returns:
com.ibm.dse.services.wosa.WOSAResult

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005