com.opencloud.slee.resources.cgin.map

Class MAPLCS_PrivacyClass

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPLCS_PrivacyClass

All Implemented Interfaces:

DataObject, Serializable

public class MAPLCS_PrivacyClass
extends AbstractFieldsObject

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

 LCS-PrivacyClass ::=
     SEQUENCE {
         ss-Code                SS-Code,
         ss-Status              Ext-SS-Status,
         notificationToMSUser   NotificationToMSUser OPTIONAL,   -- notificationToMSUser may be sent only for SS-codes callSessionRelated and callSessionUnrelated. If not received for SS-codes callSessionRelated and callSessionUnrelated, the default values according to 3GPP TS 23.271 shall be assumed.
         externalClientList     ExternalClientList OPTIONAL,     -- externalClientList may be sent only for SS-code callSessionUnrelated to a visited node that does not support LCS Release 4 or later versions.  externalClientList may be sent only for SS-codes callSessionUnrelated and callSessionRelated to a visited node that supports LCS Release 4 or later versions.
         plmnClientList         PLMNClientList OPTIONAL,         -- plmnClientList may be sent only for SS-code plmnoperator.
         extensionContainer     ExtensionContainer OPTIONAL,
         ...
         ext-externalClientList Ext-ExternalClientList OPTIONAL, -- Added in release 4.  Ext-externalClientList may be sent only if the visited node supports LCS Release 4 or later versions, the user did specify more than 5 clients, and White Book SCCP is used.
         serviceTypeList        ServiceTypeList OPTIONAL         -- Added in release 5.  serviceTypeList may be sent only for SS-code serviceType and if the visited node supports LCS Release 5 or later versions.
     }
 

Added in R98. If segmentation is used, the complete LCS-PrivacyClass shall be sent in one segment.

Used in array as field type by MAPLCSInformation.

Used in array as field type by MAPLCSInformation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPLCS_PrivacyClass	clone() Constructs a copy of this object and everything reachable from it.
static MAPLCS_PrivacyClass	copyOf(MAPLCS_PrivacyClass 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.
MAPExternalClient[]	getExt_externalClientList() Gets the value of the field ext-externalClientList.
MAPExtensionContainer	getExtensionContainer() Gets the value of the field extensionContainer.
MAPExternalClient[]	getExternalClientList() Gets the value of the field externalClientList.
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.
MAPNotificationToMSUser	getNotificationToMSUser() Gets the value of the field notificationToMSUser.
MAPLCSClientInternalID[]	getPlmnClientList() Gets the value of the field plmnClientList.
MAPServiceType[]	getServiceTypeList() Gets the value of the field serviceTypeList.
SSCode	getSs_Code() Gets the value of the field ss-Code.
byte[]	getSs_Status() Gets the value of the field ss-Status.
boolean	hasExt_externalClientList() Tests whether the field ext-externalClientList has a value.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasExternalClientList() Tests whether the field externalClientList has a value.
boolean	hasNotificationToMSUser() Tests whether the field notificationToMSUser has a value.
boolean	hasPlmnClientList() Tests whether the field plmnClientList has a value.
boolean	hasServiceTypeList() Tests whether the field serviceTypeList has a value.
boolean	hasSs_Code() Tests whether the field ss-Code has a value.
boolean	hasSs_Status() Tests whether the field ss-Status has a value.
MAPLCS_PrivacyClass	setExt_externalClientList(MAPExternalClient[] value) Sets the value of the field ext-externalClientList.
MAPLCS_PrivacyClass	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPLCS_PrivacyClass	setExternalClientList(MAPExternalClient[] value) Sets the value of the field externalClientList.
MAPLCS_PrivacyClass	setNotificationToMSUser(MAPNotificationToMSUser value) Sets the value of the field notificationToMSUser.
MAPLCS_PrivacyClass	setPlmnClientList(MAPLCSClientInternalID[] value) Sets the value of the field plmnClientList.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPLCS_PrivacyClass	setServiceTypeList(MAPServiceType[] value) Sets the value of the field serviceTypeList.
MAPLCS_PrivacyClass	setSs_Code(SSCode value) Sets the value of the field ss-Code.
MAPLCS_PrivacyClass	setSs_Status(byte[] value) Sets the value of the field ss-Status.

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

MAPLCS_PrivacyClass

public MAPLCS_PrivacyClass()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPLCS_PrivacyClass

getExt_externalClientList

public MAPExternalClient[] getExt_externalClientList()

Gets the value of the field ext-externalClientList.

Returns:

value of field ext-externalClientList, 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

getExternalClientList

public MAPExternalClient[] getExternalClientList()

Gets the value of the field externalClientList.

Returns:

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

getNotificationToMSUser

public MAPNotificationToMSUser getNotificationToMSUser()

Gets the value of the field notificationToMSUser.

Returns:

value of field notificationToMSUser, or null if not present

getPlmnClientList

public MAPLCSClientInternalID[] getPlmnClientList()

Gets the value of the field plmnClientList.

Returns:

value of field plmnClientList, or null if not present

getServiceTypeList

public MAPServiceType[] getServiceTypeList()

Gets the value of the field serviceTypeList.

Returns:

value of field serviceTypeList, or null if not present

getSs_Code

public SSCode getSs_Code()

Gets the value of the field ss-Code.

Returns:

value of field ss-Code, or null if not present

getSs_Status

public byte[] getSs_Status()

Gets the value of the field ss-Status.

Returns:

value of field ss-Status, or null if not present

hasExt_externalClientList

public boolean hasExt_externalClientList()

Tests whether the field ext-externalClientList has a value.

Returns:

whether the field ext-externalClientList has a value

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasExternalClientList

public boolean hasExternalClientList()

Tests whether the field externalClientList has a value.

Returns:

whether the field externalClientList has a value

hasNotificationToMSUser

public boolean hasNotificationToMSUser()

Tests whether the field notificationToMSUser has a value.

Returns:

whether the field notificationToMSUser has a value

hasPlmnClientList

public boolean hasPlmnClientList()

Tests whether the field plmnClientList has a value.

Returns:

whether the field plmnClientList has a value

hasServiceTypeList

public boolean hasServiceTypeList()

Tests whether the field serviceTypeList has a value.

Returns:

whether the field serviceTypeList has a value

hasSs_Code

public boolean hasSs_Code()

Tests whether the field ss-Code has a value.

Returns:

whether the field ss-Code has a value

hasSs_Status

public boolean hasSs_Status()

Tests whether the field ss-Status has a value.

Returns:

whether the field ss-Status has a value

setExt_externalClientList

public MAPLCS_PrivacyClass setExt_externalClientList(MAPExternalClient[] value)
                                              throws IllegalStateException

Sets the value of the field ext-externalClientList. 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 MAPLCS_PrivacyClass 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

setExternalClientList

public MAPLCS_PrivacyClass setExternalClientList(MAPExternalClient[] value)
                                          throws IllegalStateException

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

setNotificationToMSUser

public MAPLCS_PrivacyClass setNotificationToMSUser(MAPNotificationToMSUser value)
                                            throws IllegalStateException

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

setPlmnClientList

public MAPLCS_PrivacyClass setPlmnClientList(MAPLCSClientInternalID[] value)
                                      throws IllegalStateException

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

setServiceTypeList

public MAPLCS_PrivacyClass setServiceTypeList(MAPServiceType[] value)
                                       throws IllegalStateException

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

setSs_Code

public MAPLCS_PrivacyClass setSs_Code(SSCode value)
                               throws IllegalStateException

Sets the value of the field ss-Code.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSs_Status

public MAPLCS_PrivacyClass setSs_Status(byte[] value)
                                 throws IllegalStateException

Sets the value of the field ss-Status.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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