de.starface.integration.uci.java.v30.values
Enum FunctionKeyType

java.lang.Object
  extended by java.lang.Enum<FunctionKeyType>
      extended by de.starface.integration.uci.java.v30.values.FunctionKeyType
All Implemented Interfaces:
Serializable, Comparable<FunctionKeyType>

public enum FunctionKeyType
extends Enum<FunctionKeyType>

This enum defines the different types a function key can have. The constants are used for the function key property FunctionKeyProperties.type.


Enum Constant Summary
BUSY_LAMP_FIELD
          The busy lamp field function key shows the telephony state of another user.
COMPLETION_OF_CALLS_TO_BUSY_SUBSCRIBER
          The completion of calls to busy subscriber (CCBS) function key is used to handle the telephony feature with the same name.
DO_NOT_DISTURB
          The do not disturb function key can be used to set/reset the user's do not disturb status.
FORWARD_CALL_BUSY
          The forward call busy function key can be used to activate/deactivate the busy forwards for all of the user's phone numbers.
FORWARD_CALL_NO_RESPONSE
          The forward call no response function key can be used to activate/deactivate the no response forwards for all of the user's phone numbers.
FORWARD_CALL_UNCONDITIONAL
          The forward call unconditional function key can be used to activate/deactivate the unconditional forwards for all of the user's phone numbers.
FORWARD_NUMBER_UNCONDITIONAL
          The forward number unconditional function key can be used to activate/deactivate the unconditional forwards for a defined set of the user's phone numbers.
GROUP_LOGIN
          The group login function key can be used to log the user in/out of a defined set of groups he is a member of.
MODULE_ACTIVATION
          The module activation function key can be used to activate/deactivate a defined set of modules.
PARK_AND_ORBIT
          The park and orbit (P+O) function key is used to handle the telephony feature with the same name for a single associated parking lot per key.
PHONE_CALLLIST_INCOMING
          Telephone-only functionality.
PHONE_CALLLIST_MISSED
          Telephone-only functionality.
PHONE_CALLLIST_OUTGOING
          Telephone-only functionality.
PHONE_CONTACT_LIST
          Telephone-only functionality.
PHONE_CONTACT_SEARCH
          Telephone-only functionality.
PHONE_DTMF
          Telephone-only functionality.
PHONE_GENERIC_URL
          Telephone-only functionality.
QUICK_DIAL
          The quick dial function key is used to hold a single telephone number that is called when the function key is pressed.
SEPARATOR
          The separator function key is used to separate function keys by blank fields or a caption.
SIGNAL_NUMBER
          The signal number function key can be used to set the associated external number as displaynumber.
 
Method Summary
static FunctionKeyType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FunctionKeyType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

BUSY_LAMP_FIELD

public static final FunctionKeyType BUSY_LAMP_FIELD
The busy lamp field function key shows the telephony state of another user. The state of this function key has the following meanings: FunctionKeyState.UNAVAILABLE The other user currently has no telephones that can be called FunctionKeyState.INACTIVE The other user is currently idle. The key can be pressed to call the user. FunctionKeyState.FLASHY The other user is currently receiving a call and his phones are ringing. The key can be pressed to grab the incoming phone call. FunctionKeyState.ACTIVE The other user is currently in an active call. The function key can still be pressed to call that user but this will only be successful if the user has call waiting indication activated. FunctionKeyState.INVALID The other user's account has been removed. In addition the busy lamp field function key is the only key to hold a FunctionKeyProperties.userState property that indicates the state of the user/group the key points to. The first parameter of the UcpFunctionKeyRequests.pressKey(String, List) request denotes the phone of the user to be used to initiate/grab the call, with an empty string standing for the user's primary phone.


QUICK_DIAL

public static final FunctionKeyType QUICK_DIAL
The quick dial function key is used to hold a single telephone number that is called when the function key is pressed. The parameter of the UcpFunctionKeyRequests.pressKey(String, List) request denotes the phone of the user to be used to initiate the call, with an empty string standing for the user's primary phone.


GROUP_LOGIN

public static final FunctionKeyType GROUP_LOGIN
The group login function key can be used to log the user in/out of a defined set of groups he is a member of. The state of this function key has the following meanings: FunctionKeyState.INACTIVE The user is not logged in to any of associated groups. FunctionKeyState.FLASHY The user is logged in to some but not all of the associated groups. FunctionKeyState.ACTIVE The user is logged in to all of the associated groups. FunctionKeyState.INVALID All of the associated groups have been deleted. Pressing the key leads to the active state if the state was inactive or blinking and leads to the inactive state if the state was active. The key press thus toggles the state. As an alternative if a first Boolean parameter is given to UcpFunctionKeyRequests.pressKey(String, List) this parameter determines the requested new state of the group login.


SIGNAL_NUMBER

public static final FunctionKeyType SIGNAL_NUMBER
The signal number function key can be used to set the associated external number as displaynumber. The state of this function key has the following meanings: FunctionKeyState.INACTIVE The associated number is not used as signal number. FunctionKeyState.ACTIVE The associated number is used as signal number. FunctionKeyState.INVALID The associated number has been deleted.


MODULE_ACTIVATION

public static final FunctionKeyType MODULE_ACTIVATION
The module activation function key can be used to activate/deactivate a defined set of modules. The state of this function key has the following meanings: FunctionKeyState.INACTIVE All of the associated modules are inactive. FunctionKeyState.FLASHY Some but not all of the associated modules are active. FunctionKeyState.ACTIVE All of the associated modules are active. FunctionKeyState.INVALID All of the associated modules have been deleted. Pressing the key leads to the active state if the state was inactive or blinking and leads to the inactive state if the state was active. The key press thus toggles the state. As an alternative if a first Boolean parameter is given to UcpFunctionKeyRequests.pressKey(String, List) this parameter determines the requested new state of the module activation.


DO_NOT_DISTURB

public static final FunctionKeyType DO_NOT_DISTURB
The do not disturb function key can be used to set/reset the user's do not disturb status. The state of this function key has the following meanings: FunctionKeyState.INACTIVE The do not disturb status is inactive. FunctionKeyState.ACTIVE he do not disturb status is active. Pressing the key leads to the active state if the state was inactive and leads to the inactive state if the state was active. The key press thus toggles the state. As an alternative if a first Boolean parameter is given to UcpFunctionKeyRequests.pressKey(String, List) this parameter determines the requested new do not disturb status.


COMPLETION_OF_CALLS_TO_BUSY_SUBSCRIBER

public static final FunctionKeyType COMPLETION_OF_CALLS_TO_BUSY_SUBSCRIBER
The completion of calls to busy subscriber (CCBS) function key is used to handle the telephony feature with the same name. The state of this function key has the following meanings: FunctionKeyState.INACTIVE CCBS is currently not possible because there was no outgoing call that was signaled as busy. FunctionKeyState.FLASHY CCBS has been requested and is being performed until a timeout occurs or the call has been established or the CCBS request is cleared by a new key press each leading to the FunctionKeyState.INACTIVE state. FunctionKeyState.ACTIVE CCBS is currently possible because there was an outgoing call that was signaled as busy but has not been requested by the user. A key press will request CCBS leading to the FunctionKeyState.FLASHY state. A timeout with no action will lead back to the FunctionKeyState.INACTIVE state. The normal key press thus toggles the state. As an alternative if a first Boolean parameter is given to UcpFunctionKeyRequests.pressKey(String, List) this parameter determines the requested new CCBS state.


PARK_AND_ORBIT

public static final FunctionKeyType PARK_AND_ORBIT
The park and orbit (P+O) function key is used to handle the telephony feature with the same name for a single associated parking lot per key. The state of this function key has the following meanings: FunctionKeyState.INACTIVE The parking lot associated with this function key is empty and ready to hold a phone call. Pressing the key will forward the user's currently active call to the associated parking lot. FunctionKeyState.FLASHY A phone call has been parked in this function key's associated parking lot and is been ready to be picked. The call can be picked by pressing this key giving the phone to be used to pick the call as parameter to the UcpFunctionKeyRequests.pressKey(String, List) request using the empty string for the user's primary phone.


FORWARD_CALL_UNCONDITIONAL

public static final FunctionKeyType FORWARD_CALL_UNCONDITIONAL
The forward call unconditional function key can be used to activate/deactivate the unconditional forwards for all of the user's phone numbers. The state of this function key has the following meanings: FunctionKeyState.INACTIVE All of the user's phone number's unconditional forwards are inactive. FunctionKeyState.FLASHY Some but not all of the user's phone number's unconditional forwards are active. FunctionKeyState.ACTIVE All of the user's phone number's unconditional forwards are active. Pressing the key leads to the active state if the state was inactive or blinking and leads to the inactive state if the state was active. The key press thus toggles the state. As an alternative if a first Boolean parameter is given to UcpFunctionKeyRequests.pressKey(String, List) this parameter determines the requested new state of the call forwarding. In addition a second String parameter holding the desired target phone number can be given. If so the forwards are set to forward to this phone number independent of their previous forward target settings.


FORWARD_CALL_BUSY

public static final FunctionKeyType FORWARD_CALL_BUSY
The forward call busy function key can be used to activate/deactivate the busy forwards for all of the user's phone numbers. The state of this function key has the following meanings: FunctionKeyState.INACTIVE All of the user's phone number's busy forwards are inactive. FunctionKeyState.FLASHY Some but not all of the user's phone number's busy forwards are active. FunctionKeyState.ACTIVE All of the user's phone number's busy forwards are active. Pressing the key leads to the active state if the state was inactive or blinking and leads to the inactive state if the state was active. The key press thus toggles the state. As an alternative if a first Boolean parameter is given to UcpFunctionKeyRequests.pressKey(String, List) this parameter determines the requested new state of the call forwarding. In addition a second String parameter holding the desired target phone number can be given. If so the forwards are set to forward to this phone number independent of their previous forward target settings.


FORWARD_CALL_NO_RESPONSE

public static final FunctionKeyType FORWARD_CALL_NO_RESPONSE
The forward call no response function key can be used to activate/deactivate the no response forwards for all of the user's phone numbers. The state of this function key has the following meanings: FunctionKeyState.INACTIVE All of the user's phone number's no response forwards are inactive. FunctionKeyState.FLASHY Some but not all of the user's phone number's no response forwards are active. FunctionKeyState.ACTIVE All of the user's phone number's no response forwards are active. Pressing the key leads to the active state if the state was inactive or blinking and leads to the inactive state if the state was active. The key press thus toggles the state. As an alternative if a first Boolean parameter is given to UcpFunctionKeyRequests.pressKey(String, List) this parameter determines the requested new state of the call forwarding. In addition a second String parameter holding the desired target phone number can be given. If so the forwards are set to forward to this phone number independent of their previous forward target settings.


FORWARD_NUMBER_UNCONDITIONAL

public static final FunctionKeyType FORWARD_NUMBER_UNCONDITIONAL
The forward number unconditional function key can be used to activate/deactivate the unconditional forwards for a defined set of the user's phone numbers. The state of this function key has the following meanings: FunctionKeyState.INACTIVE All of the associated phone number's unconditional forwards are inactive. FunctionKeyState.FLASHY Some but not all of the associated phone number's unconditional forwards are active. FunctionKeyState.ACTIVE All of the associated phone number's unconditional forwards are active. FunctionKeyState.INVALID All of the associated phone numbers have been deleted. Pressing the key leads to the active state if the state was inactive or blinking and leads to the inactive state if the state was active. The key press thus toggles the state. As an alternative if a first Boolean parameter is given to UcpFunctionKeyRequests.pressKey(String, List) this parameter determines the requested new state of the call forwarding.


SEPARATOR

public static final FunctionKeyType SEPARATOR
The separator function key is used to separate function keys by blank fields or a caption. The state of this function key does not have any meaning.


PHONE_CONTACT_SEARCH

public static final FunctionKeyType PHONE_CONTACT_SEARCH
Telephone-only functionality. Stateless. Render like SEPARATOR.


PHONE_CONTACT_LIST

public static final FunctionKeyType PHONE_CONTACT_LIST
Telephone-only functionality. Stateless. Render like SEPARATOR.


PHONE_CALLLIST_INCOMING

public static final FunctionKeyType PHONE_CALLLIST_INCOMING
Telephone-only functionality. Stateless. Render like SEPARATOR.


PHONE_CALLLIST_MISSED

public static final FunctionKeyType PHONE_CALLLIST_MISSED
Telephone-only functionality. Stateless. Render like SEPARATOR.


PHONE_CALLLIST_OUTGOING

public static final FunctionKeyType PHONE_CALLLIST_OUTGOING
Telephone-only functionality. Stateless. Render like SEPARATOR.


PHONE_GENERIC_URL

public static final FunctionKeyType PHONE_GENERIC_URL
Telephone-only functionality. Stateless. Render like SEPARATOR.


PHONE_DTMF

public static final FunctionKeyType PHONE_DTMF
Telephone-only functionality. Stateless. Render like SEPARATOR.

Method Detail

values

public static FunctionKeyType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (FunctionKeyType c : FunctionKeyType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static FunctionKeyType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2012 STARFACE GmbH. All rights reserved.