com.opencloud.slee.resources.cgin.map

Class MAPSubscriberInfo

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPSubscriberInfo

All Implemented Interfaces:

DataObject, Serializable

public class MAPSubscriberInfo
extends AbstractFieldsObject

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

 SubscriberInfo ::=
     SEQUENCE {
         locationInformation               LocationInformation OPTIONAL,
         subscriberState                   SubscriberState OPTIONAL,
         extensionContainer                ExtensionContainer OPTIONAL,
         ...
         locationInformationGPRS           LocationInformationGPRS OPTIONAL,    -- Added in release 5.
         ps-SubscriberState                PS-SubscriberState OPTIONAL,         -- Added in release 5.
         imei                              IMEI OPTIONAL,                       -- Added in release 5.
         ms-Classmark2                     MS-Classmark2 OPTIONAL,              -- Added in release 5.
         gprs-MS-Class                     GPRSMSClass OPTIONAL,                -- Added in release 5.
         mnpInfoRes                        MNPInfoRes OPTIONAL,                 -- Added in release 5.
         imsVoiceOverPS-SessionsIndication IMS-VoiceOverPS-SessionsInd OPTIONAL, -- Added in release 9.
         lastUE-ActivityTime               Time OPTIONAL,                       -- Added in release 9.
         lastRAT-Type                      Used-RAT-Type OPTIONAL,              -- Added in release 9.
         eps-SubscriberState               PS-SubscriberState OPTIONAL,         -- Added in release 9.
         locationInformationEPS            LocationInformationEPS OPTIONAL      -- Added in release 9.
     }
 

Added in R96. If the HLR receives locationInformation, subscriberState or ms-Classmark2 from an SGSN it shall discard them. If the HLR receives locationInformationGPRS, ps-SubscriberState or gprs-MS-Class from a VLR it shall discard them. If the HLR receives parameters which it has not requested, it shall discard them.

Used as field type by MAPSendRoutingInfoRes_v3.

Used as field type by MAPProvideSubscriberInfoRes.

Used as field type by MAPAnyTimeInterrogationRes.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPSubscriberInfo	clone() Constructs a copy of this object and everything reachable from it.
static MAPSubscriberInfo	copyOf(MAPSubscriberInfo 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.
MAPPS_SubscriberState	getEps_SubscriberState() Gets the value of the field eps-SubscriberState.
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.
MAPGPRSMSClass	getGprs_MS_Class() Gets the value of the field gprs-MS-Class.
IMEIAddress	getImei() Gets the value of the field imei.
MAPIMS_VoiceOverPS_SessionsInd	getImsVoiceOverPS_SessionsIndication() Gets the value of the field imsVoiceOverPS-SessionsIndication.
MAPUsed_RAT_Type	getLastRAT_Type() Gets the value of the field lastRAT-Type.
byte[]	getLastUE_ActivityTime() Gets the value of the field lastUE-ActivityTime.
MAPLocationInformation	getLocationInformation() Gets the value of the field locationInformation.
MAPLocationInformationEPS	getLocationInformationEPS() Gets the value of the field locationInformationEPS.
MAPLocationInformationGPRS	getLocationInformationGPRS() Gets the value of the field locationInformationGPRS.
MAPMNPInfoRes	getMnpInfoRes() Gets the value of the field mnpInfoRes.
byte[]	getMs_Classmark2() Gets the value of the field ms-Classmark2.
MAPPS_SubscriberState	getPs_SubscriberState() Gets the value of the field ps-SubscriberState.
MAPSubscriberState	getSubscriberState() Gets the value of the field subscriberState.
boolean	hasEps_SubscriberState() Tests whether the field eps-SubscriberState has a value.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasGprs_MS_Class() Tests whether the field gprs-MS-Class has a value.
boolean	hasImei() Tests whether the field imei has a value.
boolean	hasImsVoiceOverPS_SessionsIndication() Tests whether the field imsVoiceOverPS-SessionsIndication has a value.
boolean	hasLastRAT_Type() Tests whether the field lastRAT-Type has a value.
boolean	hasLastUE_ActivityTime() Tests whether the field lastUE-ActivityTime has a value.
boolean	hasLocationInformation() Tests whether the field locationInformation has a value.
boolean	hasLocationInformationEPS() Tests whether the field locationInformationEPS has a value.
boolean	hasLocationInformationGPRS() Tests whether the field locationInformationGPRS has a value.
boolean	hasMnpInfoRes() Tests whether the field mnpInfoRes has a value.
boolean	hasMs_Classmark2() Tests whether the field ms-Classmark2 has a value.
boolean	hasPs_SubscriberState() Tests whether the field ps-SubscriberState has a value.
boolean	hasSubscriberState() Tests whether the field subscriberState has a value.
MAPSubscriberInfo	setEps_SubscriberState(MAPPS_SubscriberState value) Sets the value of the field eps-SubscriberState.
MAPSubscriberInfo	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPSubscriberInfo	setGprs_MS_Class(MAPGPRSMSClass value) Sets the value of the field gprs-MS-Class.
MAPSubscriberInfo	setImei(IMEIAddress value) Sets the value of the field imei.
MAPSubscriberInfo	setImsVoiceOverPS_SessionsIndication(MAPIMS_VoiceOverPS_SessionsInd value) Sets the value of the field imsVoiceOverPS-SessionsIndication.
MAPSubscriberInfo	setLastRAT_Type(MAPUsed_RAT_Type value) Sets the value of the field lastRAT-Type.
MAPSubscriberInfo	setLastUE_ActivityTime(byte[] value) Sets the value of the field lastUE-ActivityTime.
MAPSubscriberInfo	setLocationInformation(MAPLocationInformation value) Sets the value of the field locationInformation.
MAPSubscriberInfo	setLocationInformationEPS(MAPLocationInformationEPS value) Sets the value of the field locationInformationEPS.
MAPSubscriberInfo	setLocationInformationGPRS(MAPLocationInformationGPRS value) Sets the value of the field locationInformationGPRS.
MAPSubscriberInfo	setMnpInfoRes(MAPMNPInfoRes value) Sets the value of the field mnpInfoRes.
MAPSubscriberInfo	setMs_Classmark2(byte[] value) Sets the value of the field ms-Classmark2.
MAPSubscriberInfo	setPs_SubscriberState(MAPPS_SubscriberState value) Sets the value of the field ps-SubscriberState.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPSubscriberInfo	setSubscriberState(MAPSubscriberState value) Sets the value of the field subscriberState.

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

MAPSubscriberInfo

public MAPSubscriberInfo()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPSubscriberInfo

getEps_SubscriberState

public MAPPS_SubscriberState getEps_SubscriberState()

Gets the value of the field eps-SubscriberState.

Returns:

value of field eps-SubscriberState, 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

getGprs_MS_Class

public MAPGPRSMSClass getGprs_MS_Class()

Gets the value of the field gprs-MS-Class.

Returns:

value of field gprs-MS-Class, or null if not present

getImei

public IMEIAddress getImei()

Gets the value of the field imei.

Returns:

value of field imei, or null if not present

getImsVoiceOverPS_SessionsIndication

public MAPIMS_VoiceOverPS_SessionsInd getImsVoiceOverPS_SessionsIndication()

Gets the value of the field imsVoiceOverPS-SessionsIndication.

Returns:

value of field imsVoiceOverPS-SessionsIndication, or null if not present

getLastRAT_Type

public MAPUsed_RAT_Type getLastRAT_Type()

Gets the value of the field lastRAT-Type.

Returns:

value of field lastRAT-Type, or null if not present

getLastUE_ActivityTime

public byte[] getLastUE_ActivityTime()

Gets the value of the field lastUE-ActivityTime.

Returns:

value of field lastUE-ActivityTime, or null if not present

getLocationInformation

public MAPLocationInformation getLocationInformation()

Gets the value of the field locationInformation.

Returns:

value of field locationInformation, or null if not present

getLocationInformationEPS

public MAPLocationInformationEPS getLocationInformationEPS()

Gets the value of the field locationInformationEPS.

Returns:

value of field locationInformationEPS, or null if not present

getLocationInformationGPRS

public MAPLocationInformationGPRS getLocationInformationGPRS()

Gets the value of the field locationInformationGPRS.

Returns:

value of field locationInformationGPRS, or null if not present

getMnpInfoRes

public MAPMNPInfoRes getMnpInfoRes()

Gets the value of the field mnpInfoRes.

Returns:

value of field mnpInfoRes, or null if not present

getMs_Classmark2

public byte[] getMs_Classmark2()

Gets the value of the field ms-Classmark2.

Returns:

value of field ms-Classmark2, or null if not present

getPs_SubscriberState

public MAPPS_SubscriberState getPs_SubscriberState()

Gets the value of the field ps-SubscriberState.

Returns:

value of field ps-SubscriberState, or null if not present

getSubscriberState

public MAPSubscriberState getSubscriberState()

Gets the value of the field subscriberState.

Returns:

value of field subscriberState, or null if not present

hasEps_SubscriberState

public boolean hasEps_SubscriberState()

Tests whether the field eps-SubscriberState has a value.

Returns:

whether the field eps-SubscriberState has a value

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasGprs_MS_Class

public boolean hasGprs_MS_Class()

Tests whether the field gprs-MS-Class has a value.

Returns:

whether the field gprs-MS-Class has a value

hasImei

public boolean hasImei()

Tests whether the field imei has a value.

Returns:

whether the field imei has a value

hasImsVoiceOverPS_SessionsIndication

public boolean hasImsVoiceOverPS_SessionsIndication()

Tests whether the field imsVoiceOverPS-SessionsIndication has a value.

Returns:

whether the field imsVoiceOverPS-SessionsIndication has a value

hasLastRAT_Type

public boolean hasLastRAT_Type()

Tests whether the field lastRAT-Type has a value.

Returns:

whether the field lastRAT-Type has a value

hasLastUE_ActivityTime

public boolean hasLastUE_ActivityTime()

Tests whether the field lastUE-ActivityTime has a value.

Returns:

whether the field lastUE-ActivityTime has a value

hasLocationInformation

public boolean hasLocationInformation()

Tests whether the field locationInformation has a value.

Returns:

whether the field locationInformation has a value

hasLocationInformationEPS

public boolean hasLocationInformationEPS()

Tests whether the field locationInformationEPS has a value.

Returns:

whether the field locationInformationEPS has a value

hasLocationInformationGPRS

public boolean hasLocationInformationGPRS()

Tests whether the field locationInformationGPRS has a value.

Returns:

whether the field locationInformationGPRS has a value

hasMnpInfoRes

public boolean hasMnpInfoRes()

Tests whether the field mnpInfoRes has a value.

Returns:

whether the field mnpInfoRes has a value

hasMs_Classmark2

public boolean hasMs_Classmark2()

Tests whether the field ms-Classmark2 has a value.

Returns:

whether the field ms-Classmark2 has a value

hasPs_SubscriberState

public boolean hasPs_SubscriberState()

Tests whether the field ps-SubscriberState has a value.

Returns:

whether the field ps-SubscriberState has a value

hasSubscriberState

public boolean hasSubscriberState()

Tests whether the field subscriberState has a value.

Returns:

whether the field subscriberState has a value

setEps_SubscriberState

public MAPSubscriberInfo setEps_SubscriberState(MAPPS_SubscriberState value)
                                         throws IllegalStateException

Sets the value of the field eps-SubscriberState. 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 MAPSubscriberInfo 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

setGprs_MS_Class

public MAPSubscriberInfo setGprs_MS_Class(MAPGPRSMSClass value)
                                   throws IllegalStateException

Sets the value of the field gprs-MS-Class. 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

setImei

public MAPSubscriberInfo setImei(IMEIAddress value)
                          throws IllegalStateException

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

setImsVoiceOverPS_SessionsIndication

public MAPSubscriberInfo setImsVoiceOverPS_SessionsIndication(MAPIMS_VoiceOverPS_SessionsInd value)
                                                       throws IllegalStateException

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

setLastRAT_Type

public MAPSubscriberInfo setLastRAT_Type(MAPUsed_RAT_Type value)
                                  throws IllegalStateException

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

setLastUE_ActivityTime

public MAPSubscriberInfo setLastUE_ActivityTime(byte[] value)
                                         throws IllegalStateException

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

setLocationInformation

public MAPSubscriberInfo setLocationInformation(MAPLocationInformation value)
                                         throws IllegalStateException

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

setLocationInformationEPS

public MAPSubscriberInfo setLocationInformationEPS(MAPLocationInformationEPS value)
                                            throws IllegalStateException

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

setLocationInformationGPRS

public MAPSubscriberInfo setLocationInformationGPRS(MAPLocationInformationGPRS value)
                                             throws IllegalStateException

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

setMnpInfoRes

public MAPSubscriberInfo setMnpInfoRes(MAPMNPInfoRes value)
                                throws IllegalStateException

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

setMs_Classmark2

public MAPSubscriberInfo setMs_Classmark2(byte[] value)
                                   throws IllegalStateException

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

setPs_SubscriberState

public MAPSubscriberInfo setPs_SubscriberState(MAPPS_SubscriberState value)
                                        throws IllegalStateException

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

setSubscriberState

public MAPSubscriberInfo setSubscriberState(MAPSubscriberState value)
                                     throws IllegalStateException

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