Package com.opencloud.slee.resources.cgin.map

Class MAPSendRoutingInfoArg

  • All Implemented Interfaces:
    DataObject, Serializable
    public class MAPSendRoutingInfoArg
extends AbstractFieldsObject
    API for MAP-CH-DataTypes.SendRoutingInfoArg. Generated from the following ASN.1 type definition. 
     SendRoutingInfoArg ::=
     SEQUENCE {
         msisdn                          ISDN-AddressString,
         cug-CheckInfo                   CUG-CheckInfo OPTIONAL,
         numberOfForwarding              NumberOfForwarding OPTIONAL,
         interrogationType               InterrogationType,                   -- Added in R96.
         or-Interrogation                NULL OPTIONAL,                       -- Added in R96.
         or-Capability                   OR-Phase OPTIONAL,                   -- Added in R96.
         gmsc-OrGsmSCF-Address           ISDN-AddressString,                  -- Added in R96.  Renamed from gmsc-Address between releases 4 and 5.
         callReferenceNumber             CallReferenceNumber OPTIONAL,        -- Added in R96.
         forwardingReason                ForwardingReason OPTIONAL,           -- Added in R96.
         basicServiceGroup               Ext-BasicServiceCode OPTIONAL,       -- Added in R96.
         networkSignalInfo               ExternalSignalInfo OPTIONAL,
         camelInfo                       CamelInfo OPTIONAL,                  -- Added in R96.
         suppressionOfAnnouncement       SuppressionOfAnnouncement OPTIONAL,  -- Added in R96.
         extensionContainer              ExtensionContainer OPTIONAL,         -- Added in R96.
         ...
         alertingPattern                 AlertingPattern OPTIONAL,            -- Added in R97.
         ccbs-Call                       NULL OPTIONAL,                       -- Added in R97.
         supportedCCBS-Phase             SupportedCCBS-Phase OPTIONAL,        -- Added in R97.
         additionalSignalInfo            Ext-ExternalSignalInfo OPTIONAL,     -- Added in R98.
         istSupportIndicator             IST-SupportIndicator OPTIONAL,       -- Added in R99.
         pre-pagingSupported             NULL OPTIONAL,                       -- Added in R99.
         callDiversionTreatmentIndicator CallDiversionTreatmentIndicator OPTIONAL, -- Added in R99.  Use Treatment.TreatmentValue.ACCEPT(1) for callDiversionAllowed(1); use Treatment.TreatmentValue.REJECT(2) for callDiversionNotAllowed(2).
         longFTN-Supported               NULL OPTIONAL,                       -- Added in R99.
         suppress-VT-CSI                 NULL OPTIONAL,                       -- Added in release 5.
         suppressIncomingCallBarring     NULL OPTIONAL,                       -- Added in release 5.
         gsmSCF-InitiatedCall            NULL OPTIONAL,                       -- Added in release 5.
         basicServiceGroup2              Ext-BasicServiceCode OPTIONAL,       -- Added in release 5.
         networkSignalInfo2              ExternalSignalInfo OPTIONAL,         -- Added in release 5.
         suppressMTSS                    SuppressMTSS OPTIONAL,               -- Added in release 7.
         mtRoamingRetrySupported         NULL OPTIONAL,                       -- Added in release 7.
         callPriority                    EMLPP-Priority OPTIONAL              -- Added in release 8.
     }
    Added in ph2.

    Used as argument type by MAPOperations.sendRoutingInfo.

    Used as argument type by MAPOperations.sendRoutingInfo_v3.

    See Also:
    Serialized Form

    • Constructor Detail

      • MAPSendRoutingInfoArg

        public MAPSendRoutingInfoArg()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

        public static MAPSendRoutingInfoArg copyOf​(MAPSendRoutingInfoArg from)
        Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
        Parameters:
        from - the object from which to copy
        Returns:
        MAPSendRoutingInfoArg

      • getAdditionalSignalInfo

        public MAPExt_ExternalSignalInfo getAdditionalSignalInfo()
        Gets the value of the field additionalSignalInfo.
        Returns:
        value of field additionalSignalInfo, or null if not present

      • getAlertingPattern

        public byte[] getAlertingPattern()
        Gets the value of the field alertingPattern.
        Returns:
        value of field alertingPattern, or null if not present

      • getBasicServiceGroup

        public MAPExt_BasicServiceCode getBasicServiceGroup()
        Gets the value of the field basicServiceGroup.
        Returns:
        value of field basicServiceGroup, or null if not present

      • getBasicServiceGroup2

        public MAPExt_BasicServiceCode getBasicServiceGroup2()
        Gets the value of the field basicServiceGroup2.
        Returns:
        value of field basicServiceGroup2, or null if not present

      • getCallDiversionTreatmentIndicator

        public Treatment getCallDiversionTreatmentIndicator()
        Gets the value of the field callDiversionTreatmentIndicator.
        Returns:
        value of field callDiversionTreatmentIndicator, or null if not present

      • getCallPriority

        public int getCallPriority()
        Gets the value of the field callPriority.
        Returns:
        value of field callPriority

      • getCallReferenceNumber

        public byte[] getCallReferenceNumber()
        Gets the value of the field callReferenceNumber.
        Returns:
        value of field callReferenceNumber, or null if not present

      • getCamelInfo

        public MAPCamelInfo getCamelInfo()
        Gets the value of the field camelInfo.
        Returns:
        value of field camelInfo, or null if not present

      • getCug_CheckInfo

        public MAPCUG_CheckInfo getCug_CheckInfo()
        Gets the value of the field cug-CheckInfo.
        Returns:
        value of field cug-CheckInfo, or null if not present

      • getExtensionContainer

        public MAPExtensionContainer getExtensionContainer()
        Gets the value of the field extensionContainer.
        Returns:
        value of field extensionContainer, or null if not present

      • getFieldAccessors

        public static FieldAccessor[] getFieldAccessors()
        Gets a new array of the accessors for fields of this type.
        Returns:
        FieldAccessor[]

      • getFieldsMap

        public Map<String,​Object> getFieldsMap​(boolean withAbsents)
        Gets a Map from field-name to field-value. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an unitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED.
        Specified by:
        getFieldsMap in class AbstractFieldsObject
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value

      • getForwardingReason

        public MAPForwardingReason getForwardingReason()
        Gets the value of the field forwardingReason.
        Returns:
        value of field forwardingReason, or null if not present

      • getGmsc_OrGsmSCF_Address

        public AddressString getGmsc_OrGsmSCF_Address()
        Gets the value of the field gmsc-OrGsmSCF-Address.
        Returns:
        value of field gmsc-OrGsmSCF-Address, or null if not present

      • getInterrogationType

        public MAPInterrogationType getInterrogationType()
        Gets the value of the field interrogationType.
        Returns:
        value of field interrogationType, or null if not present

      • getIstSupportIndicator

        public MAPIST_SupportIndicator getIstSupportIndicator()
        Gets the value of the field istSupportIndicator.
        Returns:
        value of field istSupportIndicator, or null if not present

      • getMsisdn

        public AddressString getMsisdn()
        Gets the value of the field msisdn.
        Returns:
        value of field msisdn, or null if not present

      • getNetworkSignalInfo

        public MAPExternalSignalInfo getNetworkSignalInfo()
        Gets the value of the field networkSignalInfo.
        Returns:
        value of field networkSignalInfo, or null if not present

      • getNetworkSignalInfo2

        public MAPExternalSignalInfo getNetworkSignalInfo2()
        Gets the value of the field networkSignalInfo2.
        Returns:
        value of field networkSignalInfo2, or null if not present

      • getNumberOfForwarding

        public int getNumberOfForwarding()
        Gets the value of the field numberOfForwarding.
        Returns:
        value of field numberOfForwarding

      • getOr_Capability

        public int getOr_Capability()
        Gets the value of the field or-Capability.
        Returns:
        value of field or-Capability

      • getSupportedCCBS_Phase

        public int getSupportedCCBS_Phase()
        Gets the value of the field supportedCCBS-Phase.
        Returns:
        value of field supportedCCBS-Phase

      • getSuppressMTSS

        public MAPSuppressMTSS getSuppressMTSS()
        Gets the value of the field suppressMTSS.
        Returns:
        value of field suppressMTSS, or null if not present

      • hasAdditionalSignalInfo

        public boolean hasAdditionalSignalInfo()
        Tests whether the field additionalSignalInfo has a value.
        Returns:
        whether the field additionalSignalInfo has a value

      • hasAlertingPattern

        public boolean hasAlertingPattern()
        Tests whether the field alertingPattern has a value.
        Returns:
        whether the field alertingPattern has a value

      • hasBasicServiceGroup

        public boolean hasBasicServiceGroup()
        Tests whether the field basicServiceGroup has a value.
        Returns:
        whether the field basicServiceGroup has a value

      • hasBasicServiceGroup2

        public boolean hasBasicServiceGroup2()
        Tests whether the field basicServiceGroup2 has a value.
        Returns:
        whether the field basicServiceGroup2 has a value

      • hasCallDiversionTreatmentIndicator

        public boolean hasCallDiversionTreatmentIndicator()
        Tests whether the field callDiversionTreatmentIndicator has a value.
        Returns:
        whether the field callDiversionTreatmentIndicator has a value

      • hasCallPriority

        public boolean hasCallPriority()
        Tests whether the field callPriority has a value.
        Returns:
        whether the field callPriority has a value

      • hasCallReferenceNumber

        public boolean hasCallReferenceNumber()
        Tests whether the field callReferenceNumber has a value.
        Returns:
        whether the field callReferenceNumber has a value

      • hasCamelInfo

        public boolean hasCamelInfo()
        Tests whether the field camelInfo has a value.
        Returns:
        whether the field camelInfo has a value

      • hasCcbs_Call

        public boolean hasCcbs_Call()
        Tests whether the field ccbs-Call is present.
        Returns:
        whether the field ccbs-Call is present

      • hasCug_CheckInfo

        public boolean hasCug_CheckInfo()
        Tests whether the field cug-CheckInfo has a value.
        Returns:
        whether the field cug-CheckInfo has a value

      • hasExtensionContainer

        public boolean hasExtensionContainer()
        Tests whether the field extensionContainer has a value.
        Returns:
        whether the field extensionContainer has a value

      • hasForwardingReason

        public boolean hasForwardingReason()
        Tests whether the field forwardingReason has a value.
        Returns:
        whether the field forwardingReason has a value

      • hasGmsc_OrGsmSCF_Address

        public boolean hasGmsc_OrGsmSCF_Address()
        Tests whether the field gmsc-OrGsmSCF-Address has a value.
        Returns:
        whether the field gmsc-OrGsmSCF-Address has a value

      • hasGsmSCF_InitiatedCall

        public boolean hasGsmSCF_InitiatedCall()
        Tests whether the field gsmSCF-InitiatedCall is present.
        Returns:
        whether the field gsmSCF-InitiatedCall is present

      • hasInterrogationType

        public boolean hasInterrogationType()
        Tests whether the field interrogationType has a value.
        Returns:
        whether the field interrogationType has a value

      • hasIstSupportIndicator

        public boolean hasIstSupportIndicator()
        Tests whether the field istSupportIndicator has a value.
        Returns:
        whether the field istSupportIndicator has a value

      • hasLongFTN_Supported

        public boolean hasLongFTN_Supported()
        Tests whether the field longFTN-Supported is present.
        Returns:
        whether the field longFTN-Supported is present

      • hasMsisdn

        public boolean hasMsisdn()
        Tests whether the field msisdn has a value.
        Returns:
        whether the field msisdn has a value

      • hasMtRoamingRetrySupported

        public boolean hasMtRoamingRetrySupported()
        Tests whether the field mtRoamingRetrySupported is present.
        Returns:
        whether the field mtRoamingRetrySupported is present

      • hasNetworkSignalInfo

        public boolean hasNetworkSignalInfo()
        Tests whether the field networkSignalInfo has a value.
        Returns:
        whether the field networkSignalInfo has a value

      • hasNetworkSignalInfo2

        public boolean hasNetworkSignalInfo2()
        Tests whether the field networkSignalInfo2 has a value.
        Returns:
        whether the field networkSignalInfo2 has a value

      • hasNumberOfForwarding

        public boolean hasNumberOfForwarding()
        Tests whether the field numberOfForwarding has a value.
        Returns:
        whether the field numberOfForwarding has a value

      • hasOr_Capability

        public boolean hasOr_Capability()
        Tests whether the field or-Capability has a value.
        Returns:
        whether the field or-Capability has a value

      • hasOr_Interrogation

        public boolean hasOr_Interrogation()
        Tests whether the field or-Interrogation is present.
        Returns:
        whether the field or-Interrogation is present

      • hasPre_pagingSupported

        public boolean hasPre_pagingSupported()
        Tests whether the field pre-pagingSupported is present.
        Returns:
        whether the field pre-pagingSupported is present

      • hasSupportedCCBS_Phase

        public boolean hasSupportedCCBS_Phase()
        Tests whether the field supportedCCBS-Phase has a value.
        Returns:
        whether the field supportedCCBS-Phase has a value

      • hasSuppressIncomingCallBarring

        public boolean hasSuppressIncomingCallBarring()
        Tests whether the field suppressIncomingCallBarring is present.
        Returns:
        whether the field suppressIncomingCallBarring is present

      • hasSuppressMTSS

        public boolean hasSuppressMTSS()
        Tests whether the field suppressMTSS has a value.
        Returns:
        whether the field suppressMTSS has a value

      • hasSuppress_VT_CSI

        public boolean hasSuppress_VT_CSI()
        Tests whether the field suppress-VT-CSI is present.
        Returns:
        whether the field suppress-VT-CSI is present

      • hasSuppressionOfAnnouncement

        public boolean hasSuppressionOfAnnouncement()
        Tests whether the field suppressionOfAnnouncement is present.
        Returns:
        whether the field suppressionOfAnnouncement is present

      • setAlertingPattern

        public MAPSendRoutingInfoArg setAlertingPattern​(byte[] value)
                                         throws IllegalStateException
        Sets the value of the field alertingPattern. If null, marks the field as absent.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setCallDiversionTreatmentIndicator

        public MAPSendRoutingInfoArg setCallDiversionTreatmentIndicator​(Treatment value)
                                                         throws IllegalStateException
        Sets the value of the field callDiversionTreatmentIndicator. If null, marks the field as absent.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setCallPriority

        public MAPSendRoutingInfoArg setCallPriority​(int value)
                                      throws IllegalStateException
        Sets the value of the field callPriority and marks the field as present.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setCallPriorityPresent

        public MAPSendRoutingInfoArg setCallPriorityPresent​(boolean flag)
                                             throws IllegalStateException
        Sets the presence or absence of the optional field callPriority.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setCallReferenceNumber

        public MAPSendRoutingInfoArg setCallReferenceNumber​(byte[] value)
                                             throws IllegalStateException
        Sets the value of the field callReferenceNumber. If null, marks the field as absent.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setCcbs_CallPresent

        public MAPSendRoutingInfoArg setCcbs_CallPresent​(boolean flag)
                                          throws IllegalStateException
        Sets the presence or absence of the optional field ccbs-Call.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setGsmSCF_InitiatedCallPresent

        public MAPSendRoutingInfoArg setGsmSCF_InitiatedCallPresent​(boolean flag)
                                                     throws IllegalStateException
        Sets the presence or absence of the optional field gsmSCF-InitiatedCall.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setLongFTN_SupportedPresent

        public MAPSendRoutingInfoArg setLongFTN_SupportedPresent​(boolean flag)
                                                  throws IllegalStateException
        Sets the presence or absence of the optional field longFTN-Supported.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setMtRoamingRetrySupportedPresent

        public MAPSendRoutingInfoArg setMtRoamingRetrySupportedPresent​(boolean flag)
                                                        throws IllegalStateException
        Sets the presence or absence of the optional field mtRoamingRetrySupported.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setNumberOfForwarding

        public MAPSendRoutingInfoArg setNumberOfForwarding​(int value)
                                            throws IllegalStateException
        Sets the value of the field numberOfForwarding and marks the field as present.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setNumberOfForwardingPresent

        public MAPSendRoutingInfoArg setNumberOfForwardingPresent​(boolean flag)
                                                   throws IllegalStateException
        Sets the presence or absence of the optional field numberOfForwarding.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setOr_Capability

        public MAPSendRoutingInfoArg setOr_Capability​(int value)
                                       throws IllegalStateException
        Sets the value of the field or-Capability and marks the field as present.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setOr_CapabilityPresent

        public MAPSendRoutingInfoArg setOr_CapabilityPresent​(boolean flag)
                                              throws IllegalStateException
        Sets the presence or absence of the optional field or-Capability.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setOr_InterrogationPresent

        public MAPSendRoutingInfoArg setOr_InterrogationPresent​(boolean flag)
                                                 throws IllegalStateException
        Sets the presence or absence of the optional field or-Interrogation.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setPre_pagingSupportedPresent

        public MAPSendRoutingInfoArg setPre_pagingSupportedPresent​(boolean flag)
                                                    throws IllegalStateException
        Sets the presence or absence of the optional field pre-pagingSupported.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setSupportedCCBS_Phase

        public MAPSendRoutingInfoArg setSupportedCCBS_Phase​(int value)
                                             throws IllegalStateException
        Sets the value of the field supportedCCBS-Phase and marks the field as present.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setSupportedCCBS_PhasePresent

        public MAPSendRoutingInfoArg setSupportedCCBS_PhasePresent​(boolean flag)
                                                    throws IllegalStateException
        Sets the presence or absence of the optional field supportedCCBS-Phase.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setSuppressIncomingCallBarringPresent

        public MAPSendRoutingInfoArg setSuppressIncomingCallBarringPresent​(boolean flag)
                                                            throws IllegalStateException
        Sets the presence or absence of the optional field suppressIncomingCallBarring.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setSuppress_VT_CSIPresent

        public MAPSendRoutingInfoArg setSuppress_VT_CSIPresent​(boolean flag)
                                                throws IllegalStateException
        Sets the presence or absence of the optional field suppress-VT-CSI.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • setSuppressionOfAnnouncementPresent

        public MAPSendRoutingInfoArg setSuppressionOfAnnouncementPresent​(boolean flag)
                                                          throws IllegalStateException
        Sets the presence or absence of the optional field suppressionOfAnnouncement.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only