ch.ecma.csta.binding
Class LocalDeviceID
java.lang.Object
ch.ecma.csta.CastorObject
ch.ecma.csta.binding.LocalDeviceID
- All Implemented Interfaces:
- java.io.Serializable
public class LocalDeviceID
- extends ch.ecma.csta.CastorObject
- implements java.io.Serializable
Used to represent a device in the switching sub-domain.
This identifier can be either one of the two following values:
- Static - A static Device Identifier shall be stable over time.
It shall remain constant and unique between calls,
associations and within both the switching and computing functions. An
example of a static Device Identifier is an ITU-T Rec. E.164 Directory
Number. It may be useful for the Switching Function to convert a
Device Identifier to another static form for use in service
interactions. An example, it might be useful to transform a Public
Directory Number into a Private Directory Number. This transformation
allows service interactions to be independent of the identification
mechanism and allows reduction in the amount of data exchanged. This
shortened form of Device Identifier is known as a CSTA Short Form
Device Identifier.
- Dynamic - This type of identifier is one that is created by the
switching function for a device when it enters into a call and
shall remain constant for the life of the device's
participation in the call (that is, the creation of a connection
identifier for the device). As soon as the device leaves the call,
the identifier becomes invalid. The use of a dynamic identifier by
a switching function is determined when the switching function does
not have a static identifier for the device or the identifier can
not uniquely identify the device in a call. This type of identifier
is an octet string. It is never a dialable number and can never be
used outside the context of the connection identifier. This type of
identifier is not directly related to a device element but is
strictly used to make the connection identifier unique.
Refer to Management of Dynamically-Assigned Identifiers
for more information.
- Version:
- $Revision: 1.4 $ $Date: 2005/03/25 00:14:22 $
- Author:
- AVAYA, Inc.
- See Also:
- Serialized Form
Methods inherited from class ch.ecma.csta.CastorObject |
getOldSessionID, hashCode, setOldSessionID |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
LocalDeviceID
public LocalDeviceID()
getStaticID
public DeviceID getStaticID()
- Get a static device identifier.
A static Device Identifier shall be stable over time. It shall remain
constant and unique between calls, associations and within both the
switching and computing functions. An example of a static Device Identifier
is an ITU-T Rec. E.164 Directory Number. It may be useful for the Switching
Function to convert a Device Identifier to another static form for use in
service interactions. An example, it might be useful to transform a Public
Directory Number into a Private Directory Number. This transformation
allows service interactions to be independent of the identification
mechanism and allows reduction in the amount of data exchanged. This
shortened form of Device Identifier is known as a CSTA Short Form
Device Identifier.
- Returns:
- the static DeviceID represented by this LocalDeviceID.
setStaticID
public void setStaticID(DeviceID deviceID)
- Set a static device identifier.
A static Device Identifier shall be stable over time. It shall remain
constant and unique between calls, associations and within both the
switching and computing functions. An example of a static Device Identifier
is an ITU-T Rec. E.164 Directory Number. It may be useful for the Switching
Function to convert a Device Identifier to another static form for use in
service interactions. An example, it might be useful to transform a Public
Directory Number into a Private Directory Number. This transformation
allows service interactions to be independent of the identification
mechanism and allows reduction in the amount of data exchanged. This
shortened form of Device Identifier is known as a CSTA Short Form
Device Identifier.
- Parameters:
deviceID
- the static DeviceID to "copy" to this LocalDeviceID.
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
equals
public boolean equals(java.lang.Object obj)
- Note: hashCode() has not been overriden
- Overrides:
equals
in class ch.ecma.csta.CastorObject
- Parameters:
obj
-
getBitRate
public LocalDeviceIDBitRateType 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()
- 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
.
getMediaClassCount
public int getMediaClassCount()
- Not Supported.
Method getMediaClassCount
getSwitchingSubDomainCCIEType
public LocalDeviceIDSwitchingSubDomainCCIETypeType 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 LocalDeviceIDTypeOfNumberType 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(LocalDeviceIDBitRateType 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(LocalDeviceIDSwitchingSubDomainCCIETypeType 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(LocalDeviceIDTypeOfNumberType 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'.
unmarshalLocalDeviceID
public static LocalDeviceID unmarshalLocalDeviceID(java.io.Reader reader)
throws org.exolab.castor.xml.MarshalException,
org.exolab.castor.xml.ValidationException
- Method unmarshalLocalDeviceID
- 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 getStaticID ()
- Overrides:
toString
in class ch.ecma.csta.CastorObject
Copyright 2004 Avaya Inc All Rights Reserved.