de.starface.integration.uci.java.v30.ucp.messages.events
Interface UcpFunctionKeyEvents


@RpcInterface(value="ucp.v30.events.functionKey")
@UciService(value="ucp.v30.events.functionKey")
public interface UcpFunctionKeyEvents

This interface defines the function key events that can be received by the UCI client implementation in order to handle function key changes entries.


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 void functionKeysChanged(List<Map<String,Object>> functionKeys)
          This event allows the UCI client to get informed when the configuration of the function keys of the user changed.
 void functionKeySearchTerminates(String searchId)
          This event allows the UCI client to get informed when the function key searching is terminated.
 void receiveFunctionKeyState(Map<String,Object> functionKeyProperties)
          The ReceiveFunctionKeyState event provides a number of properties about the function key the state is changing of.
 

Field Detail

SERVICE_NAME

static final String SERVICE_NAME
The UCI service name used for this interface

See Also:
Constant Field Values
Method Detail

receiveFunctionKeyState

void receiveFunctionKeyState(Map<String,Object> functionKeyProperties)
The ReceiveFunctionKeyState event provides a number of properties about the function key the state is changing of. The information provided in the map is defined by its properties as seen in FunctionKeyProperties.

Parameters:
functionKeyProperties - the different properties of the function key in a Map. The constants of FunctionKeyProperties are used as keys in the map.

functionKeysChanged

void functionKeysChanged(List<Map<String,Object>> functionKeys)
This event allows the UCI client to get informed when the configuration of the function keys of the user changed.

Parameters:
functionKeys - the new function keys the user has as List of Map containing values as defined by FunctionKeyProperties.

functionKeySearchTerminates

void functionKeySearchTerminates(String searchId)
This event allows the UCI client to get informed when the function key searching is terminated.

Parameters:
searchId - the id of the terminated search


Copyright © 2012 STARFACE GmbH. All rights reserved.