Package com.opencloud.slee.resources.cgin.cap_v1

Class CAP1ConnectArg

  • All Implemented Interfaces:
    DataObject, Serializable
    Direct Known Subclasses:
    CAP2ConnectArg
    public class CAP1ConnectArg
extends CCConnectArg
    API for CAP-DataTypes.ConnectArg. Generated from the following ASN.1 type definition and the adaptations below. 
     ConnectArg ::=
     SEQUENCE {
         destinationRoutingAddress DestinationRoutingAddress,
         originalCalledPartyID     OriginalCalledPartyID OPTIONAL,
         extensions                SEQUENCE (SIZE (1..10)) OF ExtensionField OPTIONAL,
         genericNumbers            GenericNumbers OPTIONAL,
         callingPartysCategory     CallingPartysCategory OPTIONAL,
         redirectingPartyID        RedirectingPartyID OPTIONAL,
         redirectionInformation    RedirectionInformation OPTIONAL,
         suppressionOfAnnouncement SuppressionOfAnnouncement OPTIONAL,
         oCSIApplicable            OCSIApplicable OPTIONAL,
         ...
     }
 CAP-DataTypes {
     ConnectArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCConnectArg
     }
 }

    Used as argument type by CAP1Operations.connect.

    See Also:
    Serialized Form

    • Constructor Detail

      • CAP1ConnectArg

        public CAP1ConnectArg()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

        public static CAP1ConnectArg 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:
        CAP1ConnectArg

      • getExtensions

        public CAP1ExtensionField[] getExtensions()
        Gets the value of the field extensions.
        Returns:
        value of field extensions, 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.
        Overrides:
        getFieldsMap in class CCConnectArg
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value

      • getGenericNumbers

        public GenericNumber[] getGenericNumbers()
        Gets the value of the field genericNumbers.
        Returns:
        value of field genericNumbers, or null if not present

      • hasExtensions

        public boolean hasExtensions()
        Tests whether the field extensions has a value.
        Returns:
        whether the field extensions has a value

      • hasGenericNumbers

        public boolean hasGenericNumbers()
        Tests whether the field genericNumbers has a value.
        Returns:
        whether the field genericNumbers has a value

      • hasOCSIApplicable

        public boolean hasOCSIApplicable()
        Tests whether the field oCSIApplicable is present.
        Returns:
        whether the field oCSIApplicable is present

      • hasSuppressionOfAnnouncement

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

      • setOCSIApplicablePresent

        public CAP1ConnectArg setOCSIApplicablePresent​(boolean flag)
                                        throws IllegalStateException
        Sets the presence or absence of the optional field oCSIApplicable.
        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 CAP1ConnectArg 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