com.avaya.jtapi.tsapi
Class ExtendedDeviceID

java.lang.Object
  com.avaya.jtapi.tsapi.ExtendedDeviceID

public final class ExtendedDeviceID
extends java.lang.Object

A TSAPI Extended Device ID. This class should be used for interpretation of TSAPI data. Once an Extended Device ID has been constructed from TSAPI data, a JTAPI Address or Terminal object should be created using the appropriate method in ITsapiProviderPrivate.

See Also:

ITsapiProviderPrivate

Field Summary

static short	DEVICE_IDENTIFIER Device ID Type.
static short	EXPLICIT_PRIVATE_ABBREVIATED Device ID Type.
static short	EXPLICIT_PRIVATE_LEVEL1_REGIONAL_NUMBER Device ID Type.
static short	EXPLICIT_PRIVATE_LEVEL2_REGIONAL_NUMBER Device ID Type.
static short	EXPLICIT_PRIVATE_LEVEL3_REGIONAL_NUMBER Device ID Type.
static short	EXPLICIT_PRIVATE_LOCAL_NUMBER Device ID Type.
static short	EXPLICIT_PRIVATE_PTN_SPECIFIC_NUMBER Device ID Type.
static short	EXPLICIT_PRIVATE_UNKNOWN Device ID Type.
static short	EXPLICIT_PUBLIC_ABBREVIATED Device ID Type.
static short	EXPLICIT_PUBLIC_INTERNATIONAL Device ID Type.
static short	EXPLICIT_PUBLIC_NATIONAL Device ID Type.
static short	EXPLICIT_PUBLIC_NETWORK_SPECIFIC Device ID Type.
static short	EXPLICIT_PUBLIC_SUBSCRIBER Device ID Type.
static short	EXPLICIT_PUBLIC_UNKNOWN Device ID Type.
static short	ID_NOT_KNOWN Device ID Status of ID_NOT_KNOWN indicates the Device ID is not known.
static short	ID_NOT_REQUIRED Device ID Status of ID_NOT_REQUIRED indicates the Device ID is not required.
static short	ID_PROVIDED Device ID Status of ID_PROVIDED indicates the Device ID is valid
static short	IMPLICIT_PRIVATE Device ID Type.
static short	IMPLICIT_PUBLIC Device ID Type.
static short	OTHER_PLAN Device ID Type.
static short	TRUNK_GROUP_IDENTIFIER Device ID Type.
static short	TRUNK_IDENTIFIER Device ID Type.

Constructor Summary

ExtendedDeviceID(java.lang.String _deviceID, short _deviceIDType, short _deviceIDStatus)
Construct an ExtendedDeviceID.

Method Summary

java.lang.String	getDeviceID()
short	getDeviceIDStatus()
short	getDeviceIDType()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEVICE_IDENTIFIER

public static final short DEVICE_IDENTIFIER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

IMPLICIT_PUBLIC

public static final short IMPLICIT_PUBLIC

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PUBLIC_UNKNOWN

public static final short EXPLICIT_PUBLIC_UNKNOWN

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PUBLIC_INTERNATIONAL

public static final short EXPLICIT_PUBLIC_INTERNATIONAL

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PUBLIC_NATIONAL

public static final short EXPLICIT_PUBLIC_NATIONAL

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PUBLIC_NETWORK_SPECIFIC

public static final short EXPLICIT_PUBLIC_NETWORK_SPECIFIC

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PUBLIC_SUBSCRIBER

public static final short EXPLICIT_PUBLIC_SUBSCRIBER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PUBLIC_ABBREVIATED

public static final short EXPLICIT_PUBLIC_ABBREVIATED

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

IMPLICIT_PRIVATE

public static final short IMPLICIT_PRIVATE

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PRIVATE_UNKNOWN

public static final short EXPLICIT_PRIVATE_UNKNOWN

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PRIVATE_LEVEL3_REGIONAL_NUMBER

public static final short EXPLICIT_PRIVATE_LEVEL3_REGIONAL_NUMBER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PRIVATE_LEVEL2_REGIONAL_NUMBER

public static final short EXPLICIT_PRIVATE_LEVEL2_REGIONAL_NUMBER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PRIVATE_LEVEL1_REGIONAL_NUMBER

public static final short EXPLICIT_PRIVATE_LEVEL1_REGIONAL_NUMBER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PRIVATE_PTN_SPECIFIC_NUMBER

public static final short EXPLICIT_PRIVATE_PTN_SPECIFIC_NUMBER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PRIVATE_LOCAL_NUMBER

public static final short EXPLICIT_PRIVATE_LOCAL_NUMBER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

EXPLICIT_PRIVATE_ABBREVIATED

public static final short EXPLICIT_PRIVATE_ABBREVIATED

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

OTHER_PLAN

public static final short OTHER_PLAN

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

TRUNK_IDENTIFIER

public static final short TRUNK_IDENTIFIER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

TRUNK_GROUP_IDENTIFIER

public static final short TRUNK_GROUP_IDENTIFIER

Device ID Type. Ignored if Device ID Status is not ID_PROVIDED

See Also:

Constant Field Values

ID_PROVIDED

public static final short ID_PROVIDED

Device ID Status of ID_PROVIDED indicates the Device ID is valid

See Also:

Constant Field Values

ID_NOT_KNOWN

public static final short ID_NOT_KNOWN

Device ID Status of ID_NOT_KNOWN indicates the Device ID is not known. The Device ID and Device Type fields are ignored.

See Also:

Constant Field Values

ID_NOT_REQUIRED

public static final short ID_NOT_REQUIRED

Device ID Status of ID_NOT_REQUIRED indicates the Device ID is not required. The Device ID and Device Type fields are ignored.

See Also:

Constant Field Values

Constructor Detail

ExtendedDeviceID

public ExtendedDeviceID(java.lang.String _deviceID,
                        short _deviceIDType,
                        short _deviceIDStatus)

Construct an ExtendedDeviceID.

Parameters:

_deviceID - The Device ID.

_deviceIDType - The Device ID Type.

_deviceIDStatus - The status of the Device ID (ID_PROVIDED, ID_NOT_KNOWN, ID_NOT_REQUIRED).

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDeviceID

public java.lang.String getDeviceID()

Returns:

Returns the deviceID.

getDeviceIDStatus

public short getDeviceIDStatus()

Returns:

Returns the deviceIDStatus.

getDeviceIDType

public short getDeviceIDType()

Returns:

Returns the deviceIDType.