4.1.0.610 20071213

ch.ecma.csta.binding
Class LocalDeviceID

java.lang.Object
  extended by ch.ecma.csta.CastorObject
      extended by 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:

Version:
$Revision: 1.4 $ $Date: 2005/03/25 00:14:22 $
Author:
AVAYA, Inc.
See Also:
Serialized Form

Constructor Summary
LocalDeviceID()
           
 
Method Summary
 void addMediaClass(int index, java.lang.String vMediaClass)
          Method addMediaClass
 void addMediaClass(java.lang.String vMediaClass)
          Method addMediaClass
 java.util.Enumeration<java.lang.String> enumerateMediaClass()
          Method enumerateMediaClass
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 LocalDeviceIDBitRateType getBitRate()
          Get the digital data bit rate of the call.
 java.lang.Long getConnectionRate()
          Not Supported.
 java.lang.String getContent()
          Not Supported.
 java.lang.Long getDelayTolerance()
          Not Supported.
 java.lang.String[] getMediaClass()
          Not Supported.
 java.lang.String getMediaClass(int index)
          Not Supported.
 int getMediaClassCount()
          Not Supported.
 DeviceID getStaticID()
          Get a static device identifier.
 LocalDeviceIDSwitchingSubDomainCCIETypeType getSwitchingSubDomainCCIEType()
          Not Supported.
 byte[] getSwitchingSubDomainInformationElements()
          Not Supported.
 LocalDeviceIDTypeOfNumberType getTypeOfNumber()
          Get the type of number.
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void removeAllMediaClass()
          Method removeAllMediaClass
 java.lang.String removeMediaClass(int index)
          Method removeMediaClass
 void setBitRate(LocalDeviceIDBitRateType bitRate)
          Set the digital data bit rate of the call.
 void setConnectionRate(java.lang.Long connectionRate)
          Not Supported.
 void setContent(java.lang.String content)
          Not Supported.
 void setDelayTolerance(java.lang.Long delayTolerance)
          Not Supported.
 void setMediaClass(int index, java.lang.String vMediaClass)
          Not Supported.
 void setMediaClass(java.lang.String[] mediaClassArray)
          Not Supported.
 void setStaticID(DeviceID deviceID)
          Set a static device identifier.
 void setSwitchingSubDomainCCIEType(LocalDeviceIDSwitchingSubDomainCCIETypeType switchingSubDomainCCIEType)
          Not Supported.
 void setSwitchingSubDomainInformationElements(byte[] switchingSubDomainInformationElements)
          Not Supported.
 void setTypeOfNumber(LocalDeviceIDTypeOfNumberType typeOfNumber)
          Set the type of number.
 java.lang.String toString()
          Calls super.toString() and appends getStaticID ()
static LocalDeviceID unmarshalLocalDeviceID(java.io.Reader reader)
          Method unmarshalLocalDeviceID
 void validate()
          Method validate
 
Methods inherited from class ch.ecma.csta.CastorObject
getOldSessionID, hashCode, setOldSessionID
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LocalDeviceID

public LocalDeviceID()
Method Detail

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:

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:

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:


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:

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:

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:

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:

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:

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:

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:

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

4.1.0.610 20071213

Copyright 2004 Avaya Inc All Rights Reserved.