com.ibm.retail.AEF.event
Interface OperatorEvent

All Superinterfaces:
POSAppEvent, POSAppEventElement, SAXElementHandler, java.io.Serializable

public interface OperatorEvent
extends POSAppEvent

An OperatorEvent is generated when an operator signs on or off a POS terminal. The OperatorEvent object contains details about the operator and the authorization levels for the operator.


Field Summary
static java.lang.String LOCK_ACTION
          Lock action identifier
static java.lang.String SIGNOFF_ACTION
          Signoff action identifier
static java.lang.String SIGNON_ACTION
          Signon action identifier
static java.lang.String UNLOCK_ACTION
          Unlock action identifier
 
Method Summary
 java.lang.String getID()
          Get the operator logon ID.
 java.lang.String getName()
          Get the operator name.
 com.ibm.retail.AEF.automation.OperatorAuthorization getOperatorAuthorization()
          Returns information describing the functions authorized for this operator.
 boolean isAuthorized(java.lang.String authProperty)
          Indicates whether the operator is authorized for a specified operation (e.g., "NO_SALE_ALLOWED").
 
Methods inherited from interface com.ibm.retail.AEF.event.POSAppEvent
getEventType, getPropertyChangeCategory, getTerminalNumber, setEventType, setTerminalNumber
 
Methods inherited from interface com.ibm.retail.AEF.event.POSAppEventElement
getBooleanPropertyValue, getData, getIntegerPropertyValue, getProperty, getPropertyEntries, setData, setProperty, toString
 
Methods inherited from interface com.ibm.retail.AEF.xml.SAXElementHandler
endElement, startElement
 

Field Detail

SIGNON_ACTION

public static final java.lang.String SIGNON_ACTION
Signon action identifier

See Also:
Constant Field Values

SIGNOFF_ACTION

public static final java.lang.String SIGNOFF_ACTION
Signoff action identifier

See Also:
Constant Field Values

LOCK_ACTION

public static final java.lang.String LOCK_ACTION
Lock action identifier

See Also:
Constant Field Values

UNLOCK_ACTION

public static final java.lang.String UNLOCK_ACTION
Unlock action identifier

See Also:
Constant Field Values
Method Detail

getName

public java.lang.String getName()
Get the operator name.

Returns:
the name of the operator

getID

public java.lang.String getID()
Get the operator logon ID. The ID is used by the operator to sign on to a POS terminal.

Returns:
String

getOperatorAuthorization

public com.ibm.retail.AEF.automation.OperatorAuthorization getOperatorAuthorization()
Returns information describing the functions authorized for this operator.

Returns:
An OperatorAuthorization object containing authorization data.

isAuthorized

public boolean isAuthorized(java.lang.String authProperty)
                     throws AEFException
Indicates whether the operator is authorized for a specified operation (e.g., "NO_SALE_ALLOWED").

Authorizations are POS application specific, and therefore this method provides for a generic means of checking an authorization based on a property name supplied by the application. A list of property name identifiers is provided in OperatorAuthorizationProperties.

An exception is thrown if isAuthorized is called and the property is undefined by the operator event.

Parameters:
authProperty - property name
Returns:
true if the operator is authorized for the function defined by the property name.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE
See Also:
OperatorAuthorizationProperties


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