com.hp.opencall.isup.message
Class IsupFar

java.lang.Object
  extended bycom.hp.opencall.isup.message.IsupMsg
      extended bycom.hp.opencall.isup.message.IsupFar
All Implemented Interfaces:
Cloneable, Serializable

public class IsupFar
extends IsupMsg

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.hp.opencall.isup.message.IsupMsg
ACM, ALT, ANM, APM, BLA, BLO, CCL, CCR, CFN, CGB, CGBA, CGU, CGUA, CHG, CHT, CMC, CMR, CMRJ, CON, COT, CPG, CQM, CQR, CRA, CRG, CRM, CVR, CVT, DRS, EXM, FAA, FAC, FAR, FOT, FRJ, GRA, GRS, IAM, INF, INR, ITX, LOP, LPA, MPM, MSGSET_NOTSET, NRM, OLM, OPR, PRG, PRI, REL, RES, RLC, RSC, SAM, SGM, SUS, TAX, TXA, UBA, UBL, UCIC, UKWN, UPA, UPT, USERDEF, USERMSG, USR
 
Constructor Summary
IsupFar()
          Constructor
IsupFar(IsupFar aMsg)
          Constructor - Clone the classe.
IsupFar(short aMsgId)
          Deprecated. Use constructor without any parameter.
 
Method Summary
 ParmValue callReference()
          This accessor provides read access to the callReference parameter.
 void callReference(byte[] value)
          This accessor allows to write access to the callReference parameter.
 IsupFar callReference(ParmValue P_val)
          Deprecated. prefer CallReference(byte[] value. This methode clone ParmValue.
 boolean callReferenceIsPresent()
          Returns TRUE is the optional parameter callReference is present in message.
static IsupFar castMsg(IsupMsg aMsg)
          return the message.
 ParmValue connectionRequest()
          This accessor provides read access to the connectionRequest parameter.
 void connectionRequest(byte[] value)
          This accessor allows to write access to the connectionRequest parameter.
 IsupFar connectionRequest(ParmValue P_val)
          Deprecated. prefer ConnectionRequest(byte[] value. This methode clone ParmValue.
 boolean connectionRequestIsPresent()
          Returns TRUE is the optional parameter connectionRequest is present in message.
 ParmValue facilityIndicator()
          This accessor provides read access to the facilityIndicator parameter.
 void facilityIndicator(byte[] value)
          This accessor allows to write access to the facilityIndicator parameter.
 IsupFar facilityIndicator(ParmValue P_val)
          Deprecated. prefer FacilityIndicator(byte[] value. This methode clone ParmValue.
 byte[] getCallReferenceByte()
          This accessor provides read access to the callReference parameter.
 byte[] getConnectionRequestByte()
          This accessor provides read access to the connectionRequest parameter.
 byte[] getFacilityIndicatorByte()
          This accessor provides read access to the facilityIndicator parameter.
 byte[] getParameterCompatibilityByte()
          This accessor provides read access to the parameterCompatibility parameter.
 byte[] getUserToUserIndicatorsByte()
          This accessor provides read access to the userToUserIndicators parameter.
 ParmValue parameterCompatibility()
          This accessor provides read access to the parameterCompatibility parameter.
 void parameterCompatibility(byte[] value)
          This accessor allows to write access to the parameterCompatibility parameter.
 IsupFar parameterCompatibility(ParmValue P_val)
          Deprecated. prefer ParameterCompatibility(byte[] value. This methode clone ParmValue.
 boolean parameterCompatibilityIsPresent()
          Returns TRUE is the optional parameter parameterCompatibility is present in message.
 String toString()
          toString method
 String typeToStr()
          return the message type (String format)
 ParmValue userToUserIndicators()
          This accessor provides read access to the userToUserIndicators parameter.
 void userToUserIndicators(byte[] value)
          This accessor allows to write access to the userToUserIndicators parameter.
 IsupFar userToUserIndicators(ParmValue P_val)
          Deprecated. prefer UserToUserIndicators(byte[] value. This methode clone ParmValue.
 boolean userToUserIndicatorsIsPresent()
          Returns TRUE is the optional parameter userToUserIndicators is present in message.
 
Methods inherited from class com.hp.opencall.isup.message.IsupMsg
equals, freeMsgMemory, getMsgsetId, getMsgType, getPDU, isObjectValid, setMsgsetId, setPDU
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IsupFar

public IsupFar()
Constructor


IsupFar

public IsupFar(short aMsgId)
Deprecated. Use constructor without any parameter.

Constructor


IsupFar

public IsupFar(IsupFar aMsg)
        throws com.hp.opencall.isup.message.MsgException
Constructor - Clone the classe.

Method Detail

typeToStr

public String typeToStr()
Description copied from class: IsupMsg
return the message type (String format)

Overrides:
typeToStr in class IsupMsg
Returns:
String

castMsg

public static IsupFar castMsg(IsupMsg aMsg)
return the message.


toString

public String toString()
Description copied from class: IsupMsg
toString method

Overrides:
toString in class IsupMsg
Returns:
String

connectionRequestIsPresent

public boolean connectionRequestIsPresent()
                                   throws com.hp.opencall.isup.message.MsgException
Returns TRUE is the optional parameter connectionRequest is present in message. Note that no write access is provided : only the setting of a value activates the presence flag.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

connectionRequest

public ParmValue connectionRequest()
                            throws com.hp.opencall.isup.message.MsgException
This accessor provides read access to the connectionRequest parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

getConnectionRequestByte

public byte[] getConnectionRequestByte()
This accessor provides read access to the connectionRequest parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

connectionRequest

public IsupFar connectionRequest(ParmValue P_val)
                          throws com.hp.opencall.isup.message.MsgException
Deprecated. prefer ConnectionRequest(byte[] value. This methode clone ParmValue.

This accessor provides write access to the connectionRequest parameter. Setting a value will activate the presence flag. This methods does not delete the provided ParmValue instance.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

connectionRequest

public void connectionRequest(byte[] value)
                       throws com.hp.opencall.isup.message.MsgException
This accessor allows to write access to the connectionRequest parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

userToUserIndicatorsIsPresent

public boolean userToUserIndicatorsIsPresent()
                                      throws com.hp.opencall.isup.message.MsgException
Returns TRUE is the optional parameter userToUserIndicators is present in message. Note that no write access is provided : only the setting of a value activates the presence flag.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

userToUserIndicators

public ParmValue userToUserIndicators()
                               throws com.hp.opencall.isup.message.MsgException
This accessor provides read access to the userToUserIndicators parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

getUserToUserIndicatorsByte

public byte[] getUserToUserIndicatorsByte()
This accessor provides read access to the userToUserIndicators parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

userToUserIndicators

public IsupFar userToUserIndicators(ParmValue P_val)
                             throws com.hp.opencall.isup.message.MsgException
Deprecated. prefer UserToUserIndicators(byte[] value. This methode clone ParmValue.

This accessor provides write access to the userToUserIndicators parameter. Setting a value will activate the presence flag. This methods does not delete the provided ParmValue instance.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

userToUserIndicators

public void userToUserIndicators(byte[] value)
                          throws com.hp.opencall.isup.message.MsgException
This accessor allows to write access to the userToUserIndicators parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

parameterCompatibilityIsPresent

public boolean parameterCompatibilityIsPresent()
                                        throws com.hp.opencall.isup.message.MsgException
Returns TRUE is the optional parameter parameterCompatibility is present in message. Note that no write access is provided : only the setting of a value activates the presence flag.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

parameterCompatibility

public ParmValue parameterCompatibility()
                                 throws com.hp.opencall.isup.message.MsgException
This accessor provides read access to the parameterCompatibility parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

getParameterCompatibilityByte

public byte[] getParameterCompatibilityByte()
This accessor provides read access to the parameterCompatibility parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

parameterCompatibility

public IsupFar parameterCompatibility(ParmValue P_val)
                               throws com.hp.opencall.isup.message.MsgException
Deprecated. prefer ParameterCompatibility(byte[] value. This methode clone ParmValue.

This accessor provides write access to the parameterCompatibility parameter. Setting a value will activate the presence flag. This methods does not delete the provided ParmValue instance.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

parameterCompatibility

public void parameterCompatibility(byte[] value)
                            throws com.hp.opencall.isup.message.MsgException
This accessor allows to write access to the parameterCompatibility parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

callReferenceIsPresent

public boolean callReferenceIsPresent()
                               throws com.hp.opencall.isup.message.MsgException
Returns TRUE is the optional parameter callReference is present in message. Note that no write access is provided : only the setting of a value activates the presence flag.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

callReference

public ParmValue callReference()
                        throws com.hp.opencall.isup.message.MsgException
This accessor provides read access to the callReference parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

getCallReferenceByte

public byte[] getCallReferenceByte()
This accessor provides read access to the callReference parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

callReference

public IsupFar callReference(ParmValue P_val)
                      throws com.hp.opencall.isup.message.MsgException
Deprecated. prefer CallReference(byte[] value. This methode clone ParmValue.

This accessor provides write access to the callReference parameter. Setting a value will activate the presence flag. This methods does not delete the provided ParmValue instance.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

callReference

public void callReference(byte[] value)
                   throws com.hp.opencall.isup.message.MsgException
This accessor allows to write access to the callReference parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

facilityIndicator

public ParmValue facilityIndicator()
                            throws com.hp.opencall.isup.message.MsgException
This accessor provides read access to the facilityIndicator parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

getFacilityIndicatorByte

public byte[] getFacilityIndicatorByte()
This accessor provides read access to the facilityIndicator parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

facilityIndicator

public IsupFar facilityIndicator(ParmValue P_val)
                          throws com.hp.opencall.isup.message.MsgException
Deprecated. prefer FacilityIndicator(byte[] value. This methode clone ParmValue.

This accessor provides write access to the facilityIndicator parameter. Setting a value will activate the presence flag. This methods does not delete the provided ParmValue instance.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).

facilityIndicator

public void facilityIndicator(byte[] value)
                       throws com.hp.opencall.isup.message.MsgException
This accessor allows to write access to the facilityIndicator parameter.

Throws:
com.hp.opencall.isup.message.MsgException - if the method fails (returns the reason as a parameter).