com.opencloud.slee.resources.cgin.map

Class MAPPurgeMS_Res

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPPurgeMS_Res

All Implemented Interfaces:

DataObject, Serializable

public class MAPPurgeMS_Res
extends AbstractFieldsObject

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

 PurgeMS-Res ::=
     SEQUENCE {
         freezeTMSI         NULL OPTIONAL,
         freezeP-TMSI       NULL OPTIONAL,
         extensionContainer ExtensionContainer OPTIONAL,
         ...
         freezeM-TMSI       NULL OPTIONAL                -- Added in release 8.
     }
 

Added in R97.

Used as result type by MAPOperations.purgeMS_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
MAPPurgeMS_Res() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
MAPPurgeMS_Res	clone() Constructs a copy of this object and everything reachable from it.
static MAPPurgeMS_Res	copyOf(MAPPurgeMS_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.
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.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasFreezeM_TMSI() Tests whether the field freezeM-TMSI is present.
boolean	hasFreezeP_TMSI() Tests whether the field freezeP-TMSI is present.
boolean	hasFreezeTMSI() Tests whether the field freezeTMSI is present.
MAPPurgeMS_Res	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPPurgeMS_Res	setFreezeM_TMSIPresent(boolean flag) Sets the presence or absence of the optional field freezeM-TMSI.
MAPPurgeMS_Res	setFreezeP_TMSIPresent(boolean flag) Sets the presence or absence of the optional field freezeP-TMSI.
MAPPurgeMS_Res	setFreezeTMSIPresent(boolean flag) Sets the presence or absence of the optional field freezeTMSI.
void	setReadOnly() Sets this and all its fields to be immutable.

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

MAPPurgeMS_Res

public MAPPurgeMS_Res()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPPurgeMS_Res

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

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasFreezeM_TMSI

public boolean hasFreezeM_TMSI()

Tests whether the field freezeM-TMSI is present.

Returns:

whether the field freezeM-TMSI is present

hasFreezeP_TMSI

public boolean hasFreezeP_TMSI()

Tests whether the field freezeP-TMSI is present.

Returns:

whether the field freezeP-TMSI is present

hasFreezeTMSI

public boolean hasFreezeTMSI()

Tests whether the field freezeTMSI is present.

Returns:

whether the field freezeTMSI is present

setExtensionContainer

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

setFreezeM_TMSIPresent

public MAPPurgeMS_Res setFreezeM_TMSIPresent(boolean flag)
                                      throws IllegalStateException

Sets the presence or absence of the optional field freezeM-TMSI.

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

setFreezeP_TMSIPresent

public MAPPurgeMS_Res setFreezeP_TMSIPresent(boolean flag)
                                      throws IllegalStateException

Sets the presence or absence of the optional field freezeP-TMSI.

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

setFreezeTMSIPresent

public MAPPurgeMS_Res setFreezeTMSIPresent(boolean flag)
                                    throws IllegalStateException

Sets the presence or absence of the optional field freezeTMSI.

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 AbstractDataObject