com.opencloud.slee.resources.cgin.map

Class MAPPrepareHO_Res_v3

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPPrepareHO_Res

MAPPrepareHO_Res_v3

All Implemented Interfaces:

DataObject, Serializable

public class MAPPrepareHO_Res_v3
extends MAPPrepareHO_Res

API for MAP-MS-DataTypes.PrepareHO-Res-v3. Generated from the following ASN.1 type definition and the adaptations below.

 PrepareHO-Res-v3 ::=
     SEQUENCE {
         handoverNumber                 ISDN-AddressString OPTIONAL,
         relocationNumberList           RelocationNumberList OPTIONAL,       -- Added in R99.
         an-APDU                        AccessNetworkSignalInfo OPTIONAL,    -- Added in R99.
         multicallBearerInfo            MulticallBearerInfo OPTIONAL,        -- Added in R99.
         multipleBearerNotSupported     NULL OPTIONAL,                       -- Added in R99.
         selectedUMTS-Algorithms        SelectedUMTS-Algorithms OPTIONAL,    -- Added in R99.
         chosenRadioResourceInformation ChosenRadioResourceInformation OPTIONAL, -- Added in R99.
         extensionContainer             ExtensionContainer OPTIONAL,         -- Added in R99.
         ...
         iuSelectedCodec                Codec OPTIONAL,                      -- Added in release 5.
         iuAvailableCodecsList          CodecList OPTIONAL,                  -- Added in release 5.
         aoipSelectedCodecTarget        AoIPCodec OPTIONAL,                  -- Added in release 9.
         aoipAvailableCodecsListMap     AoIPCodecsList OPTIONAL              -- Added in release 9.
     }
 MAP-MS-DataTypes {
     PrepareHO-Res-v3 {
         @parentASN1Type MAP-MS-DataTypes-R98.PrepareHO-Res
     }
 }
 

Extended in R99.

Used as result type by MAPOperations.prepareHandover_v3.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
MAPPrepareHO_Res_v3() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
MAPPrepareHO_Res_v3	clone() Constructs a copy of this object and everything reachable from it.
static MAPPrepareHO_Res_v3	copyOf(MAPPrepareHO_Res 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.
MAPAccessNetworkSignalInfo	getAn_APDU() Gets the value of the field an-APDU.
MAPAoIPCodecsList	getAoipAvailableCodecsListMap() Gets the value of the field aoipAvailableCodecsListMap.
byte[]	getAoipSelectedCodecTarget() Gets the value of the field aoipSelectedCodecTarget.
MAPChosenRadioResourceInformation	getChosenRadioResourceInformation() Gets the value of the field chosenRadioResourceInformation.
MAPExtensionContainer	getExtensionContainer() Gets the value of the field extensionContainer.
static FieldAccessor[]	getFieldAccessors() Gets a new array of the accessors for fields of this type.
Map<String,Object>	getFieldsMap(boolean withAbsents) Gets a Map from field-name to field-value.
MAPCodecList	getIuAvailableCodecsList() Gets the value of the field iuAvailableCodecsList.
byte[]	getIuSelectedCodec() Gets the value of the field iuSelectedCodec.
int	getMulticallBearerInfo() Gets the value of the field multicallBearerInfo.
MAPRelocationNumber[]	getRelocationNumberList() Gets the value of the field relocationNumberList.
MAPSelectedUMTS_Algorithms	getSelectedUMTS_Algorithms() Gets the value of the field selectedUMTS-Algorithms.
boolean	hasAn_APDU() Tests whether the field an-APDU has a value.
boolean	hasAoipAvailableCodecsListMap() Tests whether the field aoipAvailableCodecsListMap has a value.
boolean	hasAoipSelectedCodecTarget() Tests whether the field aoipSelectedCodecTarget has a value.
boolean	hasChosenRadioResourceInformation() Tests whether the field chosenRadioResourceInformation has a value.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasIuAvailableCodecsList() Tests whether the field iuAvailableCodecsList has a value.
boolean	hasIuSelectedCodec() Tests whether the field iuSelectedCodec has a value.
boolean	hasMulticallBearerInfo() Tests whether the field multicallBearerInfo has a value.
boolean	hasMultipleBearerNotSupported() Tests whether the field multipleBearerNotSupported is present.
boolean	hasRelocationNumberList() Tests whether the field relocationNumberList has a value.
boolean	hasSelectedUMTS_Algorithms() Tests whether the field selectedUMTS-Algorithms has a value.
MAPPrepareHO_Res_v3	setAn_APDU(MAPAccessNetworkSignalInfo value) Sets the value of the field an-APDU.
MAPPrepareHO_Res_v3	setAoipAvailableCodecsListMap(MAPAoIPCodecsList value) Sets the value of the field aoipAvailableCodecsListMap.
MAPPrepareHO_Res_v3	setAoipSelectedCodecTarget(byte[] value) Sets the value of the field aoipSelectedCodecTarget.
MAPPrepareHO_Res_v3	setChosenRadioResourceInformation(MAPChosenRadioResourceInformation value) Sets the value of the field chosenRadioResourceInformation.
MAPPrepareHO_Res_v3	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPPrepareHO_Res_v3	setHandoverNumber(AddressString value) Sets the value of the field handoverNumber.
MAPPrepareHO_Res_v3	setIuAvailableCodecsList(MAPCodecList value) Sets the value of the field iuAvailableCodecsList.
MAPPrepareHO_Res_v3	setIuSelectedCodec(byte[] value) Sets the value of the field iuSelectedCodec.
MAPPrepareHO_Res_v3	setMulticallBearerInfo(int value) Sets the value of the field multicallBearerInfo and marks the field as present.
MAPPrepareHO_Res_v3	setMulticallBearerInfoPresent(boolean flag) Sets the presence or absence of the optional field multicallBearerInfo.
MAPPrepareHO_Res_v3	setMultipleBearerNotSupportedPresent(boolean flag) Sets the presence or absence of the optional field multipleBearerNotSupported.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPPrepareHO_Res_v3	setRelocationNumberList(MAPRelocationNumber[] value) Sets the value of the field relocationNumberList.
MAPPrepareHO_Res_v3	setSelectedUMTS_Algorithms(MAPSelectedUMTS_Algorithms value) Sets the value of the field selectedUMTS-Algorithms.

Methods inherited from class MAPPrepareHO_Res

getBss_APDU, getHandoverNumber, hasBss_APDU, hasHandoverNumber, setBss_APDU

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MAPPrepareHO_Res_v3

public MAPPrepareHO_Res_v3()

Constructs an object with uninitialised state.

Method Detail

clone

public MAPPrepareHO_Res_v3 clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Overrides:

clone in class MAPPrepareHO_Res

Returns:

copy of object

copyOf

public static MAPPrepareHO_Res_v3 copyOf(MAPPrepareHO_Res 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:

MAPPrepareHO_Res_v3

getAn_APDU

public MAPAccessNetworkSignalInfo getAn_APDU()

Gets the value of the field an-APDU.

Returns:

value of field an-APDU, or null if not present

getAoipAvailableCodecsListMap

public MAPAoIPCodecsList getAoipAvailableCodecsListMap()

Gets the value of the field aoipAvailableCodecsListMap.

Returns:

value of field aoipAvailableCodecsListMap, or null if not present

getAoipSelectedCodecTarget

public byte[] getAoipSelectedCodecTarget()

Gets the value of the field aoipSelectedCodecTarget.

Returns:

value of field aoipSelectedCodecTarget, or null if not present

getChosenRadioResourceInformation

public MAPChosenRadioResourceInformation getChosenRadioResourceInformation()

Gets the value of the field chosenRadioResourceInformation.

Returns:

value of field chosenRadioResourceInformation, 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.

Overrides:

getFieldsMap in class MAPPrepareHO_Res

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getIuAvailableCodecsList

public MAPCodecList getIuAvailableCodecsList()

Gets the value of the field iuAvailableCodecsList.

Returns:

value of field iuAvailableCodecsList, or null if not present

getIuSelectedCodec

public byte[] getIuSelectedCodec()

Gets the value of the field iuSelectedCodec.

Returns:

value of field iuSelectedCodec, or null if not present

getMulticallBearerInfo

public int getMulticallBearerInfo()

Gets the value of the field multicallBearerInfo.

Returns:

value of field multicallBearerInfo

getRelocationNumberList

public MAPRelocationNumber[] getRelocationNumberList()

Gets the value of the field relocationNumberList.

Returns:

value of field relocationNumberList, or null if not present

getSelectedUMTS_Algorithms

public MAPSelectedUMTS_Algorithms getSelectedUMTS_Algorithms()

Gets the value of the field selectedUMTS-Algorithms.

Returns:

value of field selectedUMTS-Algorithms, or null if not present

hasAn_APDU

public boolean hasAn_APDU()

Tests whether the field an-APDU has a value.

Returns:

whether the field an-APDU has a value

hasAoipAvailableCodecsListMap

public boolean hasAoipAvailableCodecsListMap()

Tests whether the field aoipAvailableCodecsListMap has a value.

Returns:

whether the field aoipAvailableCodecsListMap has a value

hasAoipSelectedCodecTarget

public boolean hasAoipSelectedCodecTarget()

Tests whether the field aoipSelectedCodecTarget has a value.

Returns:

whether the field aoipSelectedCodecTarget has a value

hasChosenRadioResourceInformation

public boolean hasChosenRadioResourceInformation()

Tests whether the field chosenRadioResourceInformation has a value.

Returns:

whether the field chosenRadioResourceInformation has a value

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasIuAvailableCodecsList

public boolean hasIuAvailableCodecsList()

Tests whether the field iuAvailableCodecsList has a value.

Returns:

whether the field iuAvailableCodecsList has a value

hasIuSelectedCodec

public boolean hasIuSelectedCodec()

Tests whether the field iuSelectedCodec has a value.

Returns:

whether the field iuSelectedCodec has a value

hasMulticallBearerInfo

public boolean hasMulticallBearerInfo()

Tests whether the field multicallBearerInfo has a value.

Returns:

whether the field multicallBearerInfo has a value

hasMultipleBearerNotSupported

public boolean hasMultipleBearerNotSupported()

Tests whether the field multipleBearerNotSupported is present.

Returns:

whether the field multipleBearerNotSupported is present

hasRelocationNumberList

public boolean hasRelocationNumberList()

Tests whether the field relocationNumberList has a value.

Returns:

whether the field relocationNumberList has a value

hasSelectedUMTS_Algorithms

public boolean hasSelectedUMTS_Algorithms()

Tests whether the field selectedUMTS-Algorithms has a value.

Returns:

whether the field selectedUMTS-Algorithms has a value

setAn_APDU

public MAPPrepareHO_Res_v3 setAn_APDU(MAPAccessNetworkSignalInfo value)
                               throws IllegalStateException

Sets the value of the field an-APDU. 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

setAoipAvailableCodecsListMap

public MAPPrepareHO_Res_v3 setAoipAvailableCodecsListMap(MAPAoIPCodecsList value)
                                                  throws IllegalStateException

Sets the value of the field aoipAvailableCodecsListMap. 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

setAoipSelectedCodecTarget

public MAPPrepareHO_Res_v3 setAoipSelectedCodecTarget(byte[] value)
                                               throws IllegalStateException

Sets the value of the field aoipSelectedCodecTarget. 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

setChosenRadioResourceInformation

public MAPPrepareHO_Res_v3 setChosenRadioResourceInformation(MAPChosenRadioResourceInformation value)
                                                      throws IllegalStateException

Sets the value of the field chosenRadioResourceInformation. 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

setExtensionContainer

public MAPPrepareHO_Res_v3 setExtensionContainer(MAPExtensionContainer value)
                                          throws IllegalStateException

Sets the value of the field extensionContainer. 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

setHandoverNumber

public MAPPrepareHO_Res_v3 setHandoverNumber(AddressString value)
                                      throws IllegalStateException

Sets the value of the field handoverNumber. If null, marks the field as absent.

Overrides:

setHandoverNumber in class MAPPrepareHO_Res

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setIuAvailableCodecsList

public MAPPrepareHO_Res_v3 setIuAvailableCodecsList(MAPCodecList value)
                                             throws IllegalStateException

Sets the value of the field iuAvailableCodecsList. 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

setIuSelectedCodec

public MAPPrepareHO_Res_v3 setIuSelectedCodec(byte[] value)
                                       throws IllegalStateException

Sets the value of the field iuSelectedCodec. 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

setMulticallBearerInfo

public MAPPrepareHO_Res_v3 setMulticallBearerInfo(int value)
                                           throws IllegalStateException

Sets the value of the field multicallBearerInfo 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

setMulticallBearerInfoPresent

public MAPPrepareHO_Res_v3 setMulticallBearerInfoPresent(boolean flag)
                                                  throws IllegalStateException

Sets the presence or absence of the optional field multicallBearerInfo.

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

setMultipleBearerNotSupportedPresent

public MAPPrepareHO_Res_v3 setMultipleBearerNotSupportedPresent(boolean flag)
                                                         throws IllegalStateException

Sets the presence or absence of the optional field multipleBearerNotSupported.

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class MAPPrepareHO_Res

setRelocationNumberList

public MAPPrepareHO_Res_v3 setRelocationNumberList(MAPRelocationNumber[] value)
                                            throws IllegalStateException

Sets the value of the field relocationNumberList. 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

setSelectedUMTS_Algorithms

public MAPPrepareHO_Res_v3 setSelectedUMTS_Algorithms(MAPSelectedUMTS_Algorithms value)
                                               throws IllegalStateException

Sets the value of the field selectedUMTS-Algorithms. 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