jain.protocol.ss7.tcap
Class GTIndicator0001

java.lang.Object
  |
  +--jain.protocol.ss7.tcap.GlobalTitle
        |
        +--jain.protocol.ss7.tcap.GTIndicator0001

All Implemented Interfaces:

java.io.Serializable

Deprecated. As of JAIN TCAP v1.1. This class is no longer needed as a result of the addition of the GTIndicator0001 class.

public final class GTIndicator0001

extends GlobalTitle

This class represents a Global Title Indicator-0001, it can be used to store, create and retrieve GlobalTitle-0001 entries. It contains the accessor methods for the following parameters in order to accommodate the difference in the protocol variants supported:

• Address Information for ITU and ANSI
• Translation Type for ANSI
• Numbering Plan for ANSI
• Encoding Scheme for ANSI
• Nature of Address Indicator for ITU
• Odd Indicator (bit 8 of Address Indicator) for ITU

For GT0001 address information it is expected that for non BCD numbers to be raw data and when BCD encoding, to be 2 BCD numbers per byte (i.e 2 address_signals/digits/numbers per byte when BCD encoding).
The nature of address indicator for GT0001, only uses bits 1 to 7 for its coding, therefore bit 8 of the octet contains the even/odd indicator which is coded as 0 for even or 1 for odd number of address_signals/digits/numbers.

Bit 8	Odd/Even
0	Even number of address signals
1	Odd number of address signals

The JAIN TCAP API provides a boolean oddIndicator, which can be used to determine the contents of the even/odd Indicator field. The isOddIndicator will return true when there is an odd number of address_signals/digits/numbers and false when there is an even number of address_signals/digits/numbers.

Global title format for Indicator 0001

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

GlobalTitle, Serialized Form

Constructor Summary

GTIndicator0001()
Deprecated. Constructs a new Global Title Indicator-0001.

Method Summary

void	clearAllParameters() Deprecated. Clears all previously set parameters.
int	getEncodingScheme() Deprecated. Gets the Encoding Scheme of this Global Title Indicator-0001.
int	getGTIndicator() Deprecated. This method returns the format of this Global Title.
int	getNatureOfAddrInd() Deprecated. Gets the Nature of Address Indicator of this Global Title Indicator-0001.
int	getNumberingPlan() Deprecated. Gets the Numbering Plan of this Global Title Indicator-0001.
byte	getTranslationType() Deprecated. Gets the Translation Type of this Global Title Indicator.
boolean	isEncodingSchemePresent() Deprecated. Indicates if the Encoding Scheme is present.
boolean	isNumberingPlanPresent() Deprecated. Indicates if the Numbering Plan is present.
boolean	isTranslationTypePresent() Deprecated. Indicates if the Translation Type is present.
void	setEncodingScheme(int encodingScheme) Deprecated. Sets the Encoding Scheme of this Global Title Indicator-0001.
void	setNatureOfAddrInd(int natureOfAddrInd) Deprecated. Sets the Nature of Address Indicator of this Global Title Indicator-0001.
void	setNumberingPlan(int numberingPlan) Deprecated. Gets the Numbering Plan of this Global Title Indicator-0001.
void	setTranslationType(byte translationType) Deprecated. Sets the Translation Type of this Global Title Indicator
java.lang.String	toString() Deprecated. Returns a description of this class

Methods inherited from class jain.protocol.ss7.tcap.GlobalTitle

getAddressInformation, isAddressInformationPresent, setAddressInformation

Methods inherited from class java.lang.Object

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

Constructor Detail

GTIndicator0001

public GTIndicator0001()

Deprecated.

Constructs a new Global Title Indicator-0001.

Method Detail

isTranslationTypePresent

public boolean isTranslationTypePresent()

Deprecated.

Indicates if the Translation Type is present.

Returns:

true if Translation Type has been set.

getTranslationType

public byte getTranslationType()
                        throws ParameterNotSetException

Deprecated.

Gets the Translation Type of this Global Title Indicator.

Returns:

the Translation Type

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setTranslationType

public void setTranslationType(byte translationType)

Deprecated.

Sets the Translation Type of this Global Title Indicator

Parameters:

translationType - the Translation Type

isNumberingPlanPresent

public boolean isNumberingPlanPresent()

Deprecated.

Indicates if the Numbering Plan is present.

Returns:

true if Numbering Plan has been set.

setNumberingPlan

public void setNumberingPlan(int numberingPlan)

Deprecated.

Gets the Numbering Plan of this Global Title Indicator-0001.

Returns:

the Numbering Plan

• NP_UNKOWN Indicates an unknown Numbering Plan
• NP_ISDN_TELIndicates ISDN/Telephony Numbering Plan
• NP_RESERVED Indicates a reserved Numbering plan in ANSI.
• NP_DATA Indicates Data Numbering Plan
• NP_TELEX Indicates a Telex Numbering Plan
• NP_MARITIME_MOBILEIndicates a Maritime Mobile Numbering Plan
• NP_LAND_MOBILE Indicates a Land Mobile Numbering Plan
• NP_ISDN_MOBILE Indicates an ISDN Mobile Numbering Plan

getNumberingPlan

public int getNumberingPlan()
                     throws ParameterNotSetException

Deprecated.

Gets the Numbering Plan of this Global Title Indicator-0001.

Returns:

the Numbering Plan

• NP_UNKOWN Indicates an unknown Numbering Plan
• NP_ISDN_TELIndicates ISDN/Telephony Numbering Plan
• NP_RESERVED Indicates a reserved Numbering plan in ANSI.
• NP_DATA Indicates Data Numbering Plan
• NP_TELEX Indicates a Telex Numbering Plan
• NP_MARITIME_MOBILEIndicates a Maritime Mobile Numbering Plan
• NP_LAND_MOBILE Indicates a Land Mobile Numbering Plan
• NP_ISDN_MOBILE Indicates an ISDN Mobile Numbering Plan

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setEncodingScheme

public void setEncodingScheme(int encodingScheme)

Deprecated.

Sets the Encoding Scheme of this Global Title Indicator-0001.

Parameters:

encodingScheme - the Encoding Scheme

• ES_UNKNOWN Indicates an unknown encoding scheme.
• ES_ODDIndicates BCD, odd number of digits
• ES_EVEN Indicates BCD, even number of digits
• ES_NATIONAL_SPECIFIC Indicates a national specific

isEncodingSchemePresent

public boolean isEncodingSchemePresent()

Deprecated.

Indicates if the Encoding Scheme is present.

Returns:

true if Encoding Scheme has been set.

getEncodingScheme

public int getEncodingScheme()
                      throws ParameterNotSetException

Deprecated.

Gets the Encoding Scheme of this Global Title Indicator-0001.

Returns:

the Encoding Scheme

• ES_UNKNOWN Indicates an unknown encoding scheme.
• ES_ODDIndicates BCD, odd number of digits
• ES_EVEN Indicates BCD, even number of digits
• ES_NATIONAL_SPECIFIC Indicates a national specific

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setNatureOfAddrInd

public void setNatureOfAddrInd(int natureOfAddrInd)

Deprecated.

Sets the Nature of Address Indicator of this Global Title Indicator-0001. The Nature of address indicator is only specific to the ITU variant.

Parameters:

natureOfAddrInd - one of the following:

• NA_UNKNOWN Indicates a unknown Nature of Address
• NA_SUBSCRIBERIndicates a subscriber number
• NA_RESERVED RESERVED for national use Nature of Address Indicator
• NA_NATIONAL_SIGNIFICANT Indicates a National Significant Number
• NA_INTERNATIONAL Indicates an international number

getNatureOfAddrInd

public int getNatureOfAddrInd()
                       throws ParameterNotSetException

Deprecated.

Gets the Nature of Address Indicator of this Global Title Indicator-0001. The nature of address indicator is only specific to the ITU variant.

Returns:

one of the following:

• NA_UNKNOWN Indicates a unknown Nature of Address
• NA_SUBSCRIBERIndicates a subscriber number
• NA_RESERVED Reserved for national use Nature of Address Indicator
• NA_NATIONAL_SIGNIFICANT Indicates a National Significant Number
• NA_INTERNATIONAL Indicates an international number

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

getGTIndicator

public int getGTIndicator()

Deprecated.

This method returns the format of this Global Title.

Overrides:

getGTIndicator in class GlobalTitle

clearAllParameters

public void clearAllParameters()

Deprecated.

Clears all previously set parameters.

Overrides:

clearAllParameters in class GlobalTitle

toString

public java.lang.String toString()

Deprecated.

Returns a description of this class

Overrides:

toString in class java.lang.Object