com.opencloud.slee.resources.cgin.map

Class MAPVoiceBroadcastData

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPVoiceBroadcastData

All Implemented Interfaces:

DataObject, Serializable

public class MAPVoiceBroadcastData
extends AbstractFieldsObject

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

 VoiceBroadcastData ::=
     SEQUENCE {
         groupid                  GroupId,                     -- groupId shall be filled with six TBCD fillers (1111) if the longGroupId is present.
         broadcastInitEntitlement NULL OPTIONAL,
         extensionContainer       ExtensionContainer OPTIONAL,
         ...
         longGroupId              Long-GroupId OPTIONAL        -- Added in release 7.
     }
 

Added in R96. VoiceBroadcastData containing a longGroupId shall not be sent to VLRs that did not indicate support of long Group IDs within the Update Location or Restore Data request message.

Used in array as field type by MAPInsertSubscriberDataArg.

Used in array as field type by MAPSubscriberData.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPVoiceBroadcastData	clone() Constructs a copy of this object and everything reachable from it.
static MAPVoiceBroadcastData	copyOf(MAPVoiceBroadcastData 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.
byte[]	getGroupid() Gets the value of the field groupid.
byte[]	getLongGroupId() Gets the value of the field longGroupId.
boolean	hasBroadcastInitEntitlement() Tests whether the field broadcastInitEntitlement is present.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasGroupid() Tests whether the field groupid has a value.
boolean	hasLongGroupId() Tests whether the field longGroupId has a value.
MAPVoiceBroadcastData	setBroadcastInitEntitlementPresent(boolean flag) Sets the presence or absence of the optional field broadcastInitEntitlement.
MAPVoiceBroadcastData	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPVoiceBroadcastData	setGroupid(byte[] value) Sets the value of the field groupid.
MAPVoiceBroadcastData	setLongGroupId(byte[] value) Sets the value of the field longGroupId.
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

MAPVoiceBroadcastData

public MAPVoiceBroadcastData()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPVoiceBroadcastData

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

getGroupid

public byte[] getGroupid()

Gets the value of the field groupid.

Returns:

value of field groupid, or null if not present

getLongGroupId

public byte[] getLongGroupId()

Gets the value of the field longGroupId.

Returns:

value of field longGroupId, or null if not present

hasBroadcastInitEntitlement

public boolean hasBroadcastInitEntitlement()

Tests whether the field broadcastInitEntitlement is present.

Returns:

whether the field broadcastInitEntitlement is present

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasGroupid

public boolean hasGroupid()

Tests whether the field groupid has a value.

Returns:

whether the field groupid has a value

hasLongGroupId

public boolean hasLongGroupId()

Tests whether the field longGroupId has a value.

Returns:

whether the field longGroupId has a value

setBroadcastInitEntitlementPresent

public MAPVoiceBroadcastData setBroadcastInitEntitlementPresent(boolean flag)
                                                         throws IllegalStateException

Sets the presence or absence of the optional field broadcastInitEntitlement.

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 MAPVoiceBroadcastData 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

setGroupid

public MAPVoiceBroadcastData setGroupid(byte[] value)
                                 throws IllegalStateException

Sets the value of the field groupid.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setLongGroupId

public MAPVoiceBroadcastData setLongGroupId(byte[] value)
                                     throws IllegalStateException

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