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

Class MAPPrepareGroupCallArg

  • All Implemented Interfaces:
    DataObject, Serializable
    public class MAPPrepareGroupCallArg
extends AbstractFieldsObject
    API for MAP-GR-DataTypes.PrepareGroupCallArg. Generated from the following ASN.1 type definition. 
     PrepareGroupCallArg ::=
     SEQUENCE {
         teleservice            Ext-TeleserviceCode,
         asciCallReference      ASCI-CallReference,
         codec-Info             CODEC-Info,
         cipheringAlgorithm     CipheringAlgorithm,
         groupKeyNumber-Vk-Id   GroupKeyNumber OPTIONAL,     -- Renamed from groupKeyNumber between releases 5 and 6.
         groupKey               Kc OPTIONAL,                 -- This parameter shall not be sent and shall be discarded if received.
         priority               EMLPP-Priority OPTIONAL,
         uplinkFree             NULL OPTIONAL,
         extensionContainer     ExtensionContainer OPTIONAL,
         ...
         vstk                   VSTK OPTIONAL,               -- Added in release 6.
         vstk-rand              VSTK-RAND OPTIONAL,          -- Added in release 6.
         talkerChannelParameter NULL OPTIONAL,               -- Added in release 8.
         uplinkReplyIndicator   NULL OPTIONAL                -- Added in release 9.
     }
    Added in R97.

    Used as argument type by MAPOperations.prepareGroupCall.

    See Also:
    Serialized Form

    • Constructor Detail

      • MAPPrepareGroupCallArg

        public MAPPrepareGroupCallArg()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

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

      • getAsciCallReference

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

      • getCipheringAlgorithm

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

      • getCodec_Info

        public byte[] getCodec_Info()
        Gets the value of the field codec-Info.
        Returns:
        value of field codec-Info, 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

      • getGroupKey

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

      • getGroupKeyNumber_Vk_Id

        public int getGroupKeyNumber_Vk_Id()
        Gets the value of the field groupKeyNumber-Vk-Id.
        Returns:
        value of field groupKeyNumber-Vk-Id

      • getPriority

        public int getPriority()
        Gets the value of the field priority.
        Returns:
        value of field priority

      • getTeleservice

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

      • getVstk

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

      • getVstk_rand

        public byte[] getVstk_rand()
        Gets the value of the field vstk-rand.
        Returns:
        value of field vstk-rand, or null if not present

      • hasAsciCallReference

        public boolean hasAsciCallReference()
        Tests whether the field asciCallReference has a value.
        Returns:
        whether the field asciCallReference has a value

      • hasCipheringAlgorithm

        public boolean hasCipheringAlgorithm()
        Tests whether the field cipheringAlgorithm has a value.
        Returns:
        whether the field cipheringAlgorithm has a value

      • hasCodec_Info

        public boolean hasCodec_Info()
        Tests whether the field codec-Info has a value.
        Returns:
        whether the field codec-Info has a value

      • hasExtensionContainer

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

      • hasGroupKey

        public boolean hasGroupKey()
        Tests whether the field groupKey has a value.
        Returns:
        whether the field groupKey has a value

      • hasGroupKeyNumber_Vk_Id

        public boolean hasGroupKeyNumber_Vk_Id()
        Tests whether the field groupKeyNumber-Vk-Id has a value.
        Returns:
        whether the field groupKeyNumber-Vk-Id has a value

      • hasPriority

        public boolean hasPriority()
        Tests whether the field priority has a value.
        Returns:
        whether the field priority has a value

      • hasTalkerChannelParameter

        public boolean hasTalkerChannelParameter()
        Tests whether the field talkerChannelParameter is present.
        Returns:
        whether the field talkerChannelParameter is present

      • hasTeleservice

        public boolean hasTeleservice()
        Tests whether the field teleservice has a value.
        Returns:
        whether the field teleservice has a value

      • hasUplinkFree

        public boolean hasUplinkFree()
        Tests whether the field uplinkFree is present.
        Returns:
        whether the field uplinkFree is present

      • hasUplinkReplyIndicator

        public boolean hasUplinkReplyIndicator()
        Tests whether the field uplinkReplyIndicator is present.
        Returns:
        whether the field uplinkReplyIndicator is present

      • hasVstk

        public boolean hasVstk()
        Tests whether the field vstk has a value.
        Returns:
        whether the field vstk has a value

      • hasVstk_rand

        public boolean hasVstk_rand()
        Tests whether the field vstk-rand has a value.
        Returns:
        whether the field vstk-rand has a value

      • setGroupKeyNumber_Vk_Id

        public MAPPrepareGroupCallArg setGroupKeyNumber_Vk_Id​(int value)
                                               throws IllegalStateException
        Sets the value of the field groupKeyNumber-Vk-Id 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

      • setGroupKeyNumber_Vk_IdPresent

        public MAPPrepareGroupCallArg setGroupKeyNumber_Vk_IdPresent​(boolean flag)
                                                      throws IllegalStateException
        Sets the presence or absence of the optional field groupKeyNumber-Vk-Id.
        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

      • setPriorityPresent

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

      • setTalkerChannelParameterPresent

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

      • setUplinkFreePresent

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

      • setUplinkReplyIndicatorPresent

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

      • setVstk_rand

        public MAPPrepareGroupCallArg setVstk_rand​(byte[] value)
                                    throws IllegalStateException
        Sets the value of the field vstk-rand. 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