ch.ecma.csta.binding
Class DeviceID
java.lang.Object
ch.ecma.csta.CastorObject
ch.ecma.csta.binding.DeviceID
- All Implemented Interfaces:
- java.io.Serializable
public class DeviceID
- extends ch.ecma.csta.CastorObject
- implements java.io.Serializable
Identifies or represents a device in the switching function.
This DeviceID parameter type consists of two components:
- Device Identifier - A mandatory component that specifies the device
identifier as described in
CSTA Device Identifier Formats.
This may include one of the following:
- a character string when using the Diallable Digits and the
Switching Function Representation formats.
- an integer value when using the Device Number format.
- Media Call Characteristics - An optional component that specifies the
media (voice, digital data, etc.) characteristics of the device. This
may be used for selecting a device based upon a particular media
capability, for example.
Refer to
Media Call Characteristics for the complete description.
The maximum length of the Device Identifier component that is supported by the
switching function is provided via the capabilities exchange services.
Functional Implementation:
- If the switching function detects a problem with a Device Identifier,
the service will be rejected with a negative acknowledgement.
- The switching function may use any format in service acknowledgements and
events.
- For Device Identifiers in service requests, the computing function should
check the
deviceIDFormat parameter in a capabilities
exchange service to determine:
- Which formats are supported.
- For the Switching Function Representation format, which notations
are supported.
- For the Diallable Digits format, which special characters are
supported.
- When providing a null Device Identifier, the Diallable Digits Format is
used.
For more details on DeviceID parameter types, refer to ECMA 269, 6.1.3, "Device".
For information on DeviceID in Connection Identifiers, refer to ECMA 269, 12.3.9,
"ConnectionID", and 6.1.5, "Connection".
- Version:
- $Revision: 1.11 $ $Date: 2005/09/07 20:12:46 $
- Author:
- AVAYA, Inc.
- See Also:
- Serialized Form
| Methods inherited from class ch.ecma.csta.CastorObject |
getOldSessionID, setOldSessionID |
| Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
DeviceID
public DeviceID()
addMediaClass
public void addMediaClass(java.lang.String vMediaClass)
throws java.lang.IndexOutOfBoundsException
- Method addMediaClass
- Parameters:
vMediaClass -
- Throws:
java.lang.IndexOutOfBoundsException
addMediaClass
public void addMediaClass(int index,
java.lang.String vMediaClass)
throws java.lang.IndexOutOfBoundsException
- Method addMediaClass
- Parameters:
index - vMediaClass -
- Throws:
java.lang.IndexOutOfBoundsException
enumerateMediaClass
public java.util.Enumeration<java.lang.String> enumerateMediaClass()
- Method enumerateMediaClass
hashCode
public int hashCode()
- Overrides:
hashCode in class ch.ecma.csta.CastorObject
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals in class ch.ecma.csta.CastorObject
getBitRate
public DeviceIDBitRateType getBitRate()
- Get the digital data bit rate of the call.
If this parameter is not present, the bit rate of the call is a constant
bit.
The following is the complete set of possible values:
- Constant (Default) - A bit rate which ensures a dedicated
bandwidth and a constant rate of media stream delivery.
- Variable - A bit rate which may variable during the life of the
call.
- Returns:
- the value of field 'bitRate'.
getConnectionRate
public java.lang.Long getConnectionRate()
- Not Supported.
Get the connection rate. This is defined as the digital data connection
rate of the call. The contents of this parameter is switching function
specific (the capability exchange services may be used to obtain the list
of possible values that are supported by the switching function). A value
of zero (0) indicates that the type of media stream associated with the
connection is digital data but the connection rate is unknown.
- Returns:
- the value of field 'connectionRate'.
getContent
public java.lang.String getContent()
- Not Supported.
Get the content. This is defined as the internal content storage.
- Returns:
- the value of field 'content'.
getDelayTolerance
public java.lang.Long getDelayTolerance()
- Not Supported.
Get the digital data delay tolerance of the call. This is defined as the
maximum amount of media stream delivery delay that will be tolerated for
the call. If the bit rate is constant, then this value will indicate the
actual amount of media stream delivery delay for the life of the call.
Where as if the bit rate is variable, it will be the maximum delay allowed
during the life of the call. The contents of this parameter is switching
function specific, use the capability exchange services to obtain the list
of possible values that are supported by the switching function. If this
parameter is not present, the delay tolerance of the call is not known.
- Returns:
- the value of field 'delayTolerance'.
getMediaClass
public java.lang.String getMediaClass(int index)
throws java.lang.IndexOutOfBoundsException
- Not Supported.
Get the media class the CSTA call belongs to.
A CSTA call shall belong to at least one and may belong to more than one
of the following classes:
- Audio - 3.1 KHz audio. Calls in this class involve devices that
are used to make audio calls excluding speech calls. This includes
calls involving devices such as G3 FAX and facsimile machines.
- Chat - A type of Data class call that involves text-based messages
that are exchanged between devices in the call using electronic media.
A chat call is interactive since devices in the call can participate
at the same time (that is, originate and receive messages during the
call.) The Data class bit must also be set for a Chat call.
- Data - This class of calls involve digital data calls (both circuit
switched and packet switched). Calls in this class include devices
such as digital computer interfaces and G4 facsimile machines.
- Email - This class of calls involve a text-based message that is
sent using electronic media. This is a noninteractive call (that is,
only one device involved with the call at one time). This is a
specific type of
mediaClass associated with electronic
mail systems.
- Image - Digital data calls involving imaging, or high-speed,
circuit-switched data in general. This includes calls involving
devices such as digital video telephones and CODECs.
- Message - This class of calls involve a text-based message that is
sent using electronic media. This is a non-interactive call (that is,
only one device is involved with the call at one time). The message
contents associated with these calls can usually be displayed on the
called devices. Instant Messages (IM), Short Message Service (SMS)
are examples of this
mediaClass.
- Voice - Speech calls. This class of calls involves devices such as
standard telephones.
- Not Known - The media class is not known.
- Other - A class of call not belonging to one of the specified
mediaClass.
- Parameters:
index -
- Throws:
java.lang.IndexOutOfBoundsException
getMediaClass
public java.lang.String[] getMediaClass()
- Get the media class the CSTA call belongs to.
A CSTA call shall belong to at least one and may belong to more than one
of the following classes:
- Audio - 3.1 KHz audio. Calls in this class involve devices that
are used to make audio calls excluding speech calls. This includes
calls involving devices such as G3 FAX and facsimile machines.
- Chat - A type of Data class call that involves text-based messages
that are exchanged between devices in the call using electronic media.
A chat call is interactive since devices in the call can participate
at the same time (that is, originate and receive messages during the
call.) The Data class bit must also be set for a Chat call.
- Data - This class of calls involve digital data calls (both circuit
switched and packet switched). Calls in this class include devices
such as digital computer interfaces and G4 facsimile machines.
- Email - This class of calls involve a text-based message that is
sent using electronic media. This is a noninteractive call (that is,
only one device involved with the call at one time). This is a
specific type of
mediaClass associated with electronic
mail systems.
- Image - Digital data calls involving imaging, or high-speed,
circuit-switched data in general. This includes calls involving
devices such as digital video telephones and CODECs.
- Message - This class of calls involve a text-based message that is
sent using electronic media. This is a non-interactive call (that is,
only one device is involved with the call at one time). The message
contents associated with these calls can usually be displayed on the
called devices. Instant Messages (IM), Short Message Service (SMS)
are examples of this
mediaClass.
- Voice - Speech calls. This class of calls involves devices such as
standard telephones.
- Not Known - The media class is not known.
- Other - A class of call not belonging to one of the specified
mediaClass.
getMediaClassCount
public int getMediaClassCount()
- Not Supported.
Method getMediaClassCount
getSwitchingSubDomainCCIEType
public DeviceIDSwitchingSubDomainCCIETypeType getSwitchingSubDomainCCIEType()
- Not Supported.
Get the type of private information elements present in the
switchingSubDomainInformationElements parameter. If this
parameter is not present, there are no information elements associated
with the call and the switchingSubDomainInformationElements
parameter should be ignored.
The following is the complete set of possible values:
- ISDN
- ATM (B-ISDN)
- ISO-Ethernet (TDM part only)
- RSVP
- SIP
- Other (switching sub-domain specific)
- Returns:
- the value of field 'switchingSubDomainCCIEType'.
getSwitchingSubDomainInformationElements
public byte[] getSwitchingSubDomainInformationElements()
- Not Supported.
Get the private information elements. This information is available from the
switching sub-domain (as specified by
switchingSubDomainCCIEType)
and represents a specific set of information elements. The format, meaning
and behaviour of these information elements are specific to the given
switching function. This parameter is only present and mandatory when the
switchingSubDomainCCIEType parameter is present.
- Returns:
- the value of field
'switchingSubDomainInformationElements'.
getTypeOfNumber
public DeviceIDTypeOfNumberType getTypeOfNumber()
- Get the type of number.
This is defined to be an enumeration which can have any of the following
values:
- dialingNumber - the default
- deviceNumber
- implicitPublic
- explicitPublic:unknown
- explicitPublic:international
- explicitPublic:national
- explicitPublic:networkspecific
- explicitPublic:subscriber
- explicitPublic:abbreviated
- implicitPrivate
- explicitPrivate:unknown
- explicitPrivate:level3RegionalNumber
- explicitPrivate:level2RegionalNumber
- explicitPrivate:level1RegionalNumber
- explicitPrivate:pTNSpecificNumber
- explicitPrivate:localNumber
- explicitPrivate:abbreviated
- other
- dynamic
- Returns:
- the value of field 'typeOfNumber'.
isValid
public boolean isValid()
- Method isValid
marshal
public void marshal(java.io.Writer out)
throws org.exolab.castor.xml.MarshalException,
org.exolab.castor.xml.ValidationException
- Method marshal
- Parameters:
out -
- Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException
marshal
public void marshal(org.xml.sax.ContentHandler handler)
throws java.io.IOException,
org.exolab.castor.xml.MarshalException,
org.exolab.castor.xml.ValidationException
- Method marshal
- Parameters:
handler -
- Throws:
java.io.IOException
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException
removeAllMediaClass
public void removeAllMediaClass()
- Method removeAllMediaClass
removeMediaClass
public java.lang.String removeMediaClass(int index)
- Method removeMediaClass
- Parameters:
index -
setBitRate
public void setBitRate(DeviceIDBitRateType bitRate)
- Set the digital data bit rate of the call.
The following is the complete set of possible values:
- Constant (Default) - A bit rate which ensures a dedicated
bandwidth and a constant rate of media stream delivery.
- Variable - A bit rate which may variable during the life of the
call.
- Parameters:
bitRate - the value of field 'bitRate'.
setConnectionRate
public void setConnectionRate(java.lang.Long connectionRate)
- Not Supported.
Set the connection Rate. This is defined as the digital data connection
rate of the call. The contents of this parameter is switching function
specific (the capability exchange services may be used to obtain the list
of possible values that are supported by the switching function). A value
of zero (0) indicates that the type of media stream associated with the
connection is digital data but the connection rate is unknown.
- Parameters:
connectionRate - the value of field 'connectionRate'.
setContent
public void setContent(java.lang.String content)
- Not Supported.
Set the content. This is defined as the internal content storage.
- Parameters:
content - the value of field 'content'.
setDelayTolerance
public void setDelayTolerance(java.lang.Long delayTolerance)
- Not Supported.
Set the digital data delay tolerance of the call. This is defined as the
maximum amount of media stream delivery delay that will be tolerated for
the call. If the bit rate is constant, then this value will indicate the
actual amount of media stream delivery delay for the life of the call.
Where as if the bit rate is variable, it will be the maximum delay allowed
during the life of the call. The contents of this parameter is switching
function specific, use the capability exchange services to obtain the list
of possible values that are supported by the switching function. If this
parameter is not present, the delay tolerance of the call is not known.
- Parameters:
delayTolerance - the value of field 'delayTolerance'.
setMediaClass
public void setMediaClass(int index,
java.lang.String vMediaClass)
throws java.lang.IndexOutOfBoundsException
- Not Supported.
Set the media class the CSTA call belongs to.
A CSTA call shall belong to at least one and may belong to more than one
of the following classes:
- Audio - 3.1 KHz audio. Calls in this class involve devices that
are used to make audio calls excluding speech calls. This includes
calls involving devices such as G3 FAX and facsimile machines.
- Chat - A type of Data class call that involves text-based messages
that are exchanged between devices in the call using electronic media.
A chat call is interactive since devices in the call can participate
at the same time (that is, originate and receive messages during the
call.) The Data class bit must also be set for a Chat call.
- Data - This class of calls involve digital data calls (both circuit
switched and packet switched). Calls in this class include devices
such as digital computer interfaces and G4 facsimile machines.
- Email - This class of calls involve a text-based message that is
sent using electronic media. This is a noninteractive call (that is,
only one device involved with the call at one time). This is a
specific type of
mediaClass associated with electronic
mail systems.
- Image - Digital data calls involving imaging, or high-speed,
circuit-switched data in general. This includes calls involving
devices such as digital video telephones and CODECs.
- Message - This class of calls involve a text-based message that is
sent using electronic media. This is a non-interactive call (that is,
only one device is involved with the call at one time). The message
contents associated with these calls can usually be displayed on the
called devices. Instant Messages (IM), Short Message Service (SMS)
are examples of this
mediaClass.
- Voice - Speech calls. This class of calls involves devices such as
standard telephones.
- Not Known - The media class is not known.
- Other - A class of call not belonging to one of the specified
mediaClass.
- Parameters:
index - vMediaClass -
- Throws:
java.lang.IndexOutOfBoundsException
setMediaClass
public void setMediaClass(java.lang.String[] mediaClassArray)
- Not Supported.
Set the media class the CSTA call belongs to.
A CSTA call shall belong to at least one and may belong to more than one
of the following classes:
- Audio - 3.1 KHz audio. Calls in this class involve devices that
are used to make audio calls excluding speech calls. This includes
calls involving devices such as G3 FAX and facsimile machines.
- Chat - A type of Data class call that involves text-based messages
that are exchanged between devices in the call using electronic media.
A chat call is interactive since devices in the call can participate
at the same time (that is, originate and receive messages during the
call.) The Data class bit must also be set for a Chat call.
- Data - This class of calls involve digital data calls (both circuit
switched and packet switched). Calls in this class include devices
such as digital computer interfaces and G4 facsimile machines.
- Email - This class of calls involve a text-based message that is
sent using electronic media. This is a noninteractive call (that is,
only one device involved with the call at one time). This is a
specific type of
mediaClass associated with electronic
mail systems.
- Image - Digital data calls involving imaging, or high-speed,
circuit-switched data in general. This includes calls involving
devices such as digital video telephones and CODECs.
- Message - This class of calls involve a text-based message that is
sent using electronic media. This is a non-interactive call (that is,
only one device is involved with the call at one time). The message
contents associated with these calls can usually be displayed on the
called devices. Instant Messages (IM), Short Message Service (SMS)
are examples of this
mediaClass.
- Voice - Speech calls. This class of calls involves devices such as
standard telephones.
- Not Known - The media class is not known.
- Other - A class of call not belonging to one of the specified
mediaClass.
- Parameters:
mediaClassArray -
setSwitchingSubDomainCCIEType
public void setSwitchingSubDomainCCIEType(DeviceIDSwitchingSubDomainCCIETypeType switchingSubDomainCCIEType)
- Not Supported.
Set the type of private information elements which are present in the
switchingSubDomainInformationElements parameter. If this
parameter is not set, there are no information elements associated
with the call and the switchingSubDomainInformationElements
parameter should be ignored.
The following is the complete set of possible values:
- ISDN
- ATM (B-ISDN)
- ISO-Ethernet (TDM part only)
- RSVP
- SIP
- Other (switching sub-domain specific)
- Parameters:
switchingSubDomainCCIEType - the value of field
'switchingSubDomainCCIEType'.
setSwitchingSubDomainInformationElements
public void setSwitchingSubDomainInformationElements(byte[] switchingSubDomainInformationElements)
- Not Supported.
Set the private information elements. This information is available from the
switching sub-domain (as specified by
switchingSubDomainCCIEType)
and represents a specific set of information elements. The format, meaning
and behaviour of these information elements are specific to the given
switching function. This parameter is only present and mandatory when the
switchingSubDomainCCIEType parameter is present.
- Parameters:
switchingSubDomainInformationElements - the value of
field 'switchingSubDomainInformationElements'.
setTypeOfNumber
public void setTypeOfNumber(DeviceIDTypeOfNumberType typeOfNumber)
- Set the type of number.
This is defined to be an enumeration which can have any of the following
values:
- dialingNumber - the default
- deviceNumber
- implicitPublic
- explicitPublic:unknown
- explicitPublic:international
- explicitPublic:national
- explicitPublic:networkspecific
- explicitPublic:subscriber
- explicitPublic:abbreviated
- implicitPrivate
- explicitPrivate:unknown
- explicitPrivate:level3RegionalNumber
- explicitPrivate:level2RegionalNumber
- explicitPrivate:level1RegionalNumber
- explicitPrivate:pTNSpecificNumber
- explicitPrivate:localNumber
- explicitPrivate:abbreviated
- other
- dynamic
- Parameters:
typeOfNumber - the value of field 'typeOfNumber'.
unmarshalDeviceID
public static DeviceID unmarshalDeviceID(java.io.Reader reader)
throws org.exolab.castor.xml.MarshalException,
org.exolab.castor.xml.ValidationException
- Method unmarshalDeviceID
- Parameters:
reader -
- Throws:
org.exolab.castor.xml.MarshalException
org.exolab.castor.xml.ValidationException
validate
public void validate()
throws org.exolab.castor.xml.ValidationException
- Method validate
- Throws:
org.exolab.castor.xml.ValidationException
toString
public java.lang.String toString()
- Calls super.toString() and appends content and type
- Overrides:
toString in class ch.ecma.csta.CastorObject
getSwitchName
public java.lang.String getSwitchName()
- Get the name of the switch that this device is associated with. If the
switch name is not part of the DeviceID, an empty string is returned.
- Returns:
- The name of this device's switch, or an empty string if the
switch name is not part of the DeviceID.
getDeviceInstance
public java.lang.String getDeviceInstance()
- Return the instance for this device. Currently not used.
- Returns:
- The instance for this device. Currently not used.
getExtension
public java.lang.String getExtension()
- Get the extension of the device
- Returns:
- Device Extension
getAddress
public java.lang.String getAddress()
- Get the H.323 address for this device
- Returns:
- H.323 address for this device
Copyright 2004 Avaya Inc All Rights Reserved.