Package com.opencloud.slee.resources.cgin.cap_v4

Class CAP4PlayAnnouncementArg

  • All Implemented Interfaces:
    DataObject, Serializable
    public class CAP4PlayAnnouncementArg
extends CAP2PlayAnnouncementArg
    API for CAP-gsmSCF-gsmSRF-ops-args.PlayAnnouncementArg. Generated from the following ASN.1 type definition and the adaptations below. 
     PlayAnnouncementArg ::=
     SEQUENCE {
         informationToSend                       InformationToSend,
         disconnectFromIPForbidden               BOOLEAN DEFAULT TRUE,
         requestAnnouncementCompleteNotification BOOLEAN DEFAULT TRUE,
         extensions                              Extensions OPTIONAL,
         callSegmentID                           CallSegmentID OPTIONAL,
         requestAnnouncementStartedNotification  BOOLEAN DEFAULT FALSE,
         ...
     }
 CAP-gsmSCF-gsmSRF-ops-args {
     PlayAnnouncementArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v2.CAP2PlayAnnouncementArg
         requestAnnouncementCompleteNotification {
             @rename requestAnnouncementComplete
         }
         requestAnnouncementStartedNotification {
             @rename requestAnnouncementStarted
         }
     }
 }

    Used as argument type by CAP4Operations.playAnnouncement.

    See Also:
    Serialized Form

    • Constructor Detail

      • CAP4PlayAnnouncementArg

        public CAP4PlayAnnouncementArg()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

        public static CAP4PlayAnnouncementArg copyOf​(CCPlayAnnouncementArg 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:
        CAP4PlayAnnouncementArg

      • getCallSegmentID

        public int getCallSegmentID()
        Gets the value of the field callSegmentID.
        Returns:
        value of field callSegmentID

      • 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 CAP2PlayAnnouncementArg
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value

      • getRequestAnnouncementStarted

        public boolean getRequestAnnouncementStarted()
        Gets the value of the field requestAnnouncementStartedNotification.
        Returns:
        value of field requestAnnouncementStartedNotification

      • hasCallSegmentID

        public boolean hasCallSegmentID()
        Tests whether the field callSegmentID has a value.
        Returns:
        whether the field callSegmentID has a value

      • hasRequestAnnouncementStarted

        public boolean hasRequestAnnouncementStarted()
        Tests whether the field requestAnnouncementStartedNotification has a value.
        Returns:
        whether the field requestAnnouncementStartedNotification has a value

      • setCallSegmentID

        public CAP4PlayAnnouncementArg setCallSegmentID​(int value)
                                         throws IllegalStateException
        Sets the value of the field callSegmentID 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

      • setCallSegmentIDPresent

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

      • setRequestAnnouncementStarted

        public CAP4PlayAnnouncementArg setRequestAnnouncementStarted​(boolean value)
                                                      throws IllegalStateException
        Sets the value of the field requestAnnouncementStartedNotification 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

      • setRequestAnnouncementStartedPresent

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