com.opencloud.slee.resources.cgin.map

Class MAPUpdateLocationArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPUpdateLocationArg

All Implemented Interfaces:

DataObject, Serializable

public class MAPUpdateLocationArg
extends AbstractFieldsObject

API for MAP-MS-DataTypes.UpdateLocationArg. Generated from the following ASN.1 type definition.

 UpdateLocationArg ::=
     SEQUENCE {
         imsi                        IMSI,
         msc-Number                  ISDN-AddressString,          -- Renamed from locationInfo between ph2 and R96.
         vlr-Number                  ISDN-AddressString,          -- Renamed from vlrNumber between ph1 and ph2.
         lmsi                        LMSI OPTIONAL,               -- Renamed from lmsId between ph1 and ph2.
         extensionContainer          ExtensionContainer OPTIONAL, -- Added in R96.
         ...
         vlr-Capability              VLR-Capability OPTIONAL,     -- Added in R97.
         informPreviousNetworkEntity NULL OPTIONAL,               -- Added in R99.
         cs-LCS-NotSupportedByUE     NULL OPTIONAL,               -- Added in release 5.
         v-gmlc-Address              GSN-Address OPTIONAL,        -- Added in release 6.
         add-info                    ADD-Info OPTIONAL,           -- Added in release 6.
         pagingArea                  PagingArea OPTIONAL,         -- Added in release 8.
         skipSubscriberDataUpdate    NULL OPTIONAL,               -- Added in release 8.
         restorationIndicator        NULL OPTIONAL                -- Added in release 9.
     }
 

Present in ph1. The skipSubscriberDataUpdate parameter in the UpdateLocationArg and the ADD-Info structures carry the same semantic.

Used as argument type by MAPOperations.updateLocation.

Used as argument type by MAPOperations.updateLocation_v1.

Used as argument type by MAPOperations.updateLocation_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
MAPUpdateLocationArg() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
MAPUpdateLocationArg	clone() Constructs a copy of this object and everything reachable from it.
static MAPUpdateLocationArg	copyOf(MAPUpdateLocationArg 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.
MAPADD_Info	getAdd_info() Gets the value of the field add-info.
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.
IMSIAddress	getImsi() Gets the value of the field imsi.
LMSIAddress	getLmsi() Gets the value of the field lmsi.
AddressString	getMsc_Number() Gets the value of the field msc-Number.
MAPLocationArea[]	getPagingArea() Gets the value of the field pagingArea.
GSNAddress	getV_gmlc_Address() Gets the value of the field v-gmlc-Address.
MAPVLR_Capability	getVlr_Capability() Gets the value of the field vlr-Capability.
AddressString	getVlr_Number() Gets the value of the field vlr-Number.
boolean	hasAdd_info() Tests whether the field add-info has a value.
boolean	hasCs_LCS_NotSupportedByUE() Tests whether the field cs-LCS-NotSupportedByUE is present.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasImsi() Tests whether the field imsi has a value.
boolean	hasInformPreviousNetworkEntity() Tests whether the field informPreviousNetworkEntity is present.
boolean	hasLmsi() Tests whether the field lmsi has a value.
boolean	hasMsc_Number() Tests whether the field msc-Number has a value.
boolean	hasPagingArea() Tests whether the field pagingArea has a value.
boolean	hasRestorationIndicator() Tests whether the field restorationIndicator is present.
boolean	hasSkipSubscriberDataUpdate() Tests whether the field skipSubscriberDataUpdate is present.
boolean	hasV_gmlc_Address() Tests whether the field v-gmlc-Address has a value.
boolean	hasVlr_Capability() Tests whether the field vlr-Capability has a value.
boolean	hasVlr_Number() Tests whether the field vlr-Number has a value.
MAPUpdateLocationArg	setAdd_info(MAPADD_Info value) Sets the value of the field add-info.
MAPUpdateLocationArg	setCs_LCS_NotSupportedByUEPresent(boolean flag) Sets the presence or absence of the optional field cs-LCS-NotSupportedByUE.
MAPUpdateLocationArg	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPUpdateLocationArg	setImsi(IMSIAddress value) Sets the value of the field imsi.
MAPUpdateLocationArg	setInformPreviousNetworkEntityPresent(boolean flag) Sets the presence or absence of the optional field informPreviousNetworkEntity.
MAPUpdateLocationArg	setLmsi(LMSIAddress value) Sets the value of the field lmsi.
MAPUpdateLocationArg	setMsc_Number(AddressString value) Sets the value of the field msc-Number.
MAPUpdateLocationArg	setPagingArea(MAPLocationArea[] value) Sets the value of the field pagingArea.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPUpdateLocationArg	setRestorationIndicatorPresent(boolean flag) Sets the presence or absence of the optional field restorationIndicator.
MAPUpdateLocationArg	setSkipSubscriberDataUpdatePresent(boolean flag) Sets the presence or absence of the optional field skipSubscriberDataUpdate.
MAPUpdateLocationArg	setV_gmlc_Address(GSNAddress value) Sets the value of the field v-gmlc-Address.
MAPUpdateLocationArg	setVlr_Capability(MAPVLR_Capability value) Sets the value of the field vlr-Capability.
MAPUpdateLocationArg	setVlr_Number(AddressString value) Sets the value of the field vlr-Number.

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

MAPUpdateLocationArg

public MAPUpdateLocationArg()

Constructs an object with uninitialised state.

Method Detail

clone

public MAPUpdateLocationArg clone()

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

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

copyOf

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

MAPUpdateLocationArg

getAdd_info

public MAPADD_Info getAdd_info()

Gets the value of the field add-info.

Returns:

value of field add-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

getImsi

public IMSIAddress getImsi()

Gets the value of the field imsi.

Returns:

value of field imsi, or null if not present

getLmsi

public LMSIAddress getLmsi()

Gets the value of the field lmsi.

Returns:

value of field lmsi, or null if not present

getMsc_Number

public AddressString getMsc_Number()

Gets the value of the field msc-Number.

Returns:

value of field msc-Number, or null if not present

getPagingArea

public MAPLocationArea[] getPagingArea()

Gets the value of the field pagingArea.

Returns:

value of field pagingArea, or null if not present

getV_gmlc_Address

public GSNAddress getV_gmlc_Address()

Gets the value of the field v-gmlc-Address.

Returns:

value of field v-gmlc-Address, or null if not present

getVlr_Capability

public MAPVLR_Capability getVlr_Capability()

Gets the value of the field vlr-Capability.

Returns:

value of field vlr-Capability, or null if not present

getVlr_Number

public AddressString getVlr_Number()

Gets the value of the field vlr-Number.

Returns:

value of field vlr-Number, or null if not present

hasAdd_info

public boolean hasAdd_info()

Tests whether the field add-info has a value.

Returns:

whether the field add-info has a value

hasCs_LCS_NotSupportedByUE

public boolean hasCs_LCS_NotSupportedByUE()

Tests whether the field cs-LCS-NotSupportedByUE is present.

Returns:

whether the field cs-LCS-NotSupportedByUE is present

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasImsi

public boolean hasImsi()

Tests whether the field imsi has a value.

Returns:

whether the field imsi has a value

hasInformPreviousNetworkEntity

public boolean hasInformPreviousNetworkEntity()

Tests whether the field informPreviousNetworkEntity is present.

Returns:

whether the field informPreviousNetworkEntity is present

hasLmsi

public boolean hasLmsi()

Tests whether the field lmsi has a value.

Returns:

whether the field lmsi has a value

hasMsc_Number

public boolean hasMsc_Number()

Tests whether the field msc-Number has a value.

Returns:

whether the field msc-Number has a value

hasPagingArea

public boolean hasPagingArea()

Tests whether the field pagingArea has a value.

Returns:

whether the field pagingArea has a value

hasRestorationIndicator

public boolean hasRestorationIndicator()

Tests whether the field restorationIndicator is present.

Returns:

whether the field restorationIndicator is present

hasSkipSubscriberDataUpdate

public boolean hasSkipSubscriberDataUpdate()

Tests whether the field skipSubscriberDataUpdate is present.

Returns:

whether the field skipSubscriberDataUpdate is present

hasV_gmlc_Address

public boolean hasV_gmlc_Address()

Tests whether the field v-gmlc-Address has a value.

Returns:

whether the field v-gmlc-Address has a value

hasVlr_Capability

public boolean hasVlr_Capability()

Tests whether the field vlr-Capability has a value.

Returns:

whether the field vlr-Capability has a value

hasVlr_Number

public boolean hasVlr_Number()

Tests whether the field vlr-Number has a value.

Returns:

whether the field vlr-Number has a value

setAdd_info

public MAPUpdateLocationArg setAdd_info(MAPADD_Info value)
                                 throws IllegalStateException

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

setCs_LCS_NotSupportedByUEPresent

public MAPUpdateLocationArg setCs_LCS_NotSupportedByUEPresent(boolean flag)
                                                       throws IllegalStateException

Sets the presence or absence of the optional field cs-LCS-NotSupportedByUE.

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

setExtensionContainer

public MAPUpdateLocationArg 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

setImsi

public MAPUpdateLocationArg setImsi(IMSIAddress value)
                             throws IllegalStateException

Sets the value of the field imsi.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setInformPreviousNetworkEntityPresent

public MAPUpdateLocationArg setInformPreviousNetworkEntityPresent(boolean flag)
                                                           throws IllegalStateException

Sets the presence or absence of the optional field informPreviousNetworkEntity.

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

setLmsi

public MAPUpdateLocationArg setLmsi(LMSIAddress value)
                             throws IllegalStateException

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

setMsc_Number

public MAPUpdateLocationArg setMsc_Number(AddressString value)
                                   throws IllegalStateException

Sets the value of the field msc-Number.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setPagingArea

public MAPUpdateLocationArg setPagingArea(MAPLocationArea[] value)
                                   throws IllegalStateException

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setRestorationIndicatorPresent

public MAPUpdateLocationArg setRestorationIndicatorPresent(boolean flag)
                                                    throws IllegalStateException

Sets the presence or absence of the optional field restorationIndicator.

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

setSkipSubscriberDataUpdatePresent

public MAPUpdateLocationArg setSkipSubscriberDataUpdatePresent(boolean flag)
                                                        throws IllegalStateException

Sets the presence or absence of the optional field skipSubscriberDataUpdate.

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

setV_gmlc_Address

public MAPUpdateLocationArg setV_gmlc_Address(GSNAddress value)
                                       throws IllegalStateException

Sets the value of the field v-gmlc-Address. 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

setVlr_Capability

public MAPUpdateLocationArg setVlr_Capability(MAPVLR_Capability value)
                                       throws IllegalStateException

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

setVlr_Number

public MAPUpdateLocationArg setVlr_Number(AddressString value)
                                   throws IllegalStateException

Sets the value of the field vlr-Number.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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