com.ibm.retail.AEF.mgmt
Interface SessionControlMBean


public interface SessionControlMBean

Specifies a "control" management interface for AEFSession objects.

The purpose of this MBean is to allow more detailed control of an AEFSession than what is available through the base SessionMBean management interface. MBeans of this type are created on demand through SessionMBean.enableDetailedControl(). When not needed anymore, these MBeans should be destroyed via SessionMBean.destroyDetailedControl().

The ObjectName of this MBean includes the following attributes, in addition to the SIF attributes of StoreID and DeviceID:

This management interface does not include any attributes.

The following operations are included in this management interface. These are described in more detail in the corresponding method documentation.

No notifications are generated by classes implementing this interface.


Method Summary
 void initializeSession(int initialState)
          Initialize the AEFSession.
 void sendKeySequence(java.lang.String keySequence)
          Send a key sequence to the POS application associated with this session.
 void setKeyLockPosition(int lock)
          Set the keylock position of the terminal associated with this session.
 

Method Detail

initializeSession

public void initializeSession(int initialState)
                       throws AEFException
Initialize the AEFSession. Refer to POSAutomationProvider.initialize() for information on valid initial states, results of this operation, and pertinent error codes that can be thrown with the AEFException.

Note: this method applies only to virtual (CSS) sessions.

Throws:
AEFException
See Also:
POSAutomationProvider.initialize(int)

sendKeySequence

public void sendKeySequence(java.lang.String keySequence)
                     throws AEFException
Send a key sequence to the POS application associated with this session. Refer to Workstation.sendKeySequence() for information on the format of a valid key sequence as well as pertinent error codes that can be thrown with the AEFException.

Throws:
AEFException
See Also:
Workstation.sendKeySequence(String)

setKeyLockPosition

public void setKeyLockPosition(int lock)
                        throws AEFException
Set the keylock position of the terminal associated with this session. Refer to Workstation.setKeyLockPosition() for information on valid keylock positions as well as pertinent error codes that can be thrown with the AEFException.

Throws:
AEFException
See Also:
Workstation.setKeyLockPosition(int)


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004