Class CCConnectArg

  • All Implemented Interfaces:
    DataObject, Serializable
    Direct Known Subclasses:
    CAP1ConnectArg, CS1ConnectArg

    public class CCConnectArg
    extends AbstractFieldsObject
    API for CC-DataTypes.ConnectArg. Generated from the following ASN.1 type definition.
     ConnectArg ::=
         SEQUENCE {
             destinationRoutingAddress DestinationRoutingAddress OPTIONAL,
             alertingPattern           AlertingPattern OPTIONAL,
             originalCalledPartyID     OriginalCalledPartyID OPTIONAL,
             callingPartysCategory     CallingPartysCategory OPTIONAL,
             redirectingPartyID        RedirectingPartyID OPTIONAL,
             redirectionInformation    RedirectionInformation OPTIONAL
         }
     

    Used as argument type by CCOperations.connect.

    See Also:
    Serialized Form
    • Constructor Detail

      • CCConnectArg

        public CCConnectArg()
        Constructs an object with uninitialised state.
    • Method Detail

      • copyOf

        public static CCConnectArg copyOf​(CCConnectArg 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:
        CCConnectArg
      • getAlertingPattern

        public Signal getAlertingPattern()
        Gets the value of the field alertingPattern.
        Returns:
        value of field alertingPattern, or null if not present
      • getCallingPartysCategory

        public CallingPartysCategory getCallingPartysCategory()
        Gets the value of the field callingPartysCategory.
        Returns:
        value of field callingPartysCategory, or null if not present
      • getDestinationRoutingAddress

        public CalledPartyNumber[] getDestinationRoutingAddress()
        Gets the value of the field destinationRoutingAddress.
        Returns:
        value of field destinationRoutingAddress, 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
      • getOriginalCalledPartyID

        public OriginalCalledNumber getOriginalCalledPartyID()
        Gets the value of the field originalCalledPartyID.
        Returns:
        value of field originalCalledPartyID, or null if not present
      • getRedirectingPartyID

        public RedirectingPartyNumber getRedirectingPartyID()
        Gets the value of the field redirectingPartyID.
        Returns:
        value of field redirectingPartyID, or null if not present
      • getRedirectionInformation

        public RedirectionInformation getRedirectionInformation()
        Gets the value of the field redirectionInformation.
        Returns:
        value of field redirectionInformation, or null if not present
      • hasAlertingPattern

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

        public boolean hasCallingPartysCategory()
        Tests whether the field callingPartysCategory has a value.
        Returns:
        whether the field callingPartysCategory has a value
      • hasDestinationRoutingAddress

        public boolean hasDestinationRoutingAddress()
        Tests whether the field destinationRoutingAddress has a value.
        Returns:
        whether the field destinationRoutingAddress has a value
      • hasOriginalCalledPartyID

        public boolean hasOriginalCalledPartyID()
        Tests whether the field originalCalledPartyID has a value.
        Returns:
        whether the field originalCalledPartyID has a value
      • hasRedirectingPartyID

        public boolean hasRedirectingPartyID()
        Tests whether the field redirectingPartyID has a value.
        Returns:
        whether the field redirectingPartyID has a value
      • hasRedirectionInformation

        public boolean hasRedirectionInformation()
        Tests whether the field redirectionInformation has a value.
        Returns:
        whether the field redirectionInformation has a value
      • setAlertingPattern

        public CCConnectArg setAlertingPattern​(Signal 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
      • setDestinationRoutingAddress

        public CCConnectArg setDestinationRoutingAddress​(CalledPartyNumber[] value)
                                                  throws IllegalStateException
        Sets the value of the field destinationRoutingAddress. 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