com.opencloud.slee.resources.cgin.map

Class MAPUSSD_Arg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPUSSD_Arg

All Implemented Interfaces:

DataObject, Serializable

public class MAPUSSD_Arg
extends AbstractFieldsObject

API for MAP-SS-DataTypes.USSD-Arg. Generated from the following ASN.1 type definition.

 USSD-Arg ::=
     SEQUENCE {
         ussd-DataCodingScheme USSD-DataCodingScheme,
         ussd-String           USSD-String,
         ...
         alertingPattern       AlertingPattern OPTIONAL,   -- Added in R97.
         msisdn                ISDN-AddressString OPTIONAL -- Added in R97.
     }
 

Added in ph2.

Used as argument type by MAPOperations.processUnstructuredSS_Request.

Used as argument type by MAPOperations.unstructuredSS_Notify.

Used as argument type by MAPOperations.unstructuredSS_Request.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPUSSD_Arg	clone() Constructs a copy of this object and everything reachable from it.
static MAPUSSD_Arg	copyOf(MAPUSSD_Arg 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.
byte[]	getAlertingPattern() Gets the value of the field alertingPattern.
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.
AddressString	getMsisdn() Gets the value of the field msisdn.
byte[]	getUssd_DataCodingScheme() Gets the value of the field ussd-DataCodingScheme.
byte[]	getUssd_String() Gets the value of the field ussd-String.
boolean	hasAlertingPattern() Tests whether the field alertingPattern has a value.
boolean	hasMsisdn() Tests whether the field msisdn has a value.
boolean	hasUssd_DataCodingScheme() Tests whether the field ussd-DataCodingScheme has a value.
boolean	hasUssd_String() Tests whether the field ussd-String has a value.
MAPUSSD_Arg	setAlertingPattern(byte[] value) Sets the value of the field alertingPattern.
MAPUSSD_Arg	setMsisdn(AddressString value) Sets the value of the field msisdn.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPUSSD_Arg	setUssd_DataCodingScheme(byte[] value) Sets the value of the field ussd-DataCodingScheme.
MAPUSSD_Arg	setUssd_String(byte[] value) Sets the value of the field ussd-String.

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

MAPUSSD_Arg

public MAPUSSD_Arg()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPUSSD_Arg

getAlertingPattern

public byte[] getAlertingPattern()

Gets the value of the field alertingPattern.

Returns:

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

getMsisdn

public AddressString getMsisdn()

Gets the value of the field msisdn.

Returns:

value of field msisdn, or null if not present

getUssd_DataCodingScheme

public byte[] getUssd_DataCodingScheme()

Gets the value of the field ussd-DataCodingScheme.

Returns:

value of field ussd-DataCodingScheme, or null if not present

getUssd_String

public byte[] getUssd_String()

Gets the value of the field ussd-String.

Returns:

value of field ussd-String, or null if not present

hasAlertingPattern

public boolean hasAlertingPattern()

Tests whether the field alertingPattern has a value.

Returns:

whether the field alertingPattern has a value

hasMsisdn

public boolean hasMsisdn()

Tests whether the field msisdn has a value.

Returns:

whether the field msisdn has a value

hasUssd_DataCodingScheme

public boolean hasUssd_DataCodingScheme()

Tests whether the field ussd-DataCodingScheme has a value.

Returns:

whether the field ussd-DataCodingScheme has a value

hasUssd_String

public boolean hasUssd_String()

Tests whether the field ussd-String has a value.

Returns:

whether the field ussd-String has a value

setAlertingPattern

public MAPUSSD_Arg setAlertingPattern(byte[] value)
                               throws IllegalStateException

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

setMsisdn

public MAPUSSD_Arg setMsisdn(AddressString value)
                      throws IllegalStateException

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

setUssd_DataCodingScheme

public MAPUSSD_Arg setUssd_DataCodingScheme(byte[] value)
                                     throws IllegalStateException

Sets the value of the field ussd-DataCodingScheme.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setUssd_String

public MAPUSSD_Arg setUssd_String(byte[] value)
                           throws IllegalStateException

Sets the value of the field ussd-String.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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