com.opencloud.slee.resources.cgin.map

Class MAPMT_ForwardSM_Arg_v3

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPMT_ForwardSM_Arg

MAPMT_ForwardSM_Arg_v2

MAPMT_ForwardSM_Arg_v3

All Implemented Interfaces:

DataObject, Serializable

public class MAPMT_ForwardSM_Arg_v3
extends MAPMT_ForwardSM_Arg_v2

API for MAP-SM-DataTypes.MT-ForwardSM-Arg-v3. Generated from the following ASN.1 type definition and the adaptations below.

 MT-ForwardSM-Arg-v3 ::=
     SEQUENCE {
         sm-RP-DA            SM-RP-DA,
         sm-RP-OA            SM-RP-OA,
         sm-RP-UI            SignalInfo,
         moreMessagesToSend  NULL OPTIONAL,
         extensionContainer  ExtensionContainer OPTIONAL,    -- Added in R96.
         ...
         smDeliveryTimer     SM-DeliveryTimerValue OPTIONAL, -- Added in release 10.  Contains the value used by the SMS-GMSC.
         smDeliveryStartTime Time OPTIONAL                   -- Added in release 10.  SM-DeliveryTimerValue contains the value used by the SMS-GMSC.
     }
 MAP-SM-DataTypes {
     MT-ForwardSM-Arg-v3 {
         @parentASN1Type MAP-SM-DataTypes-ph2.MT-ForwardSM-Arg-v2
         sm-RP-UI {
             @api {
                 @decodeMethod com.opencloud.slee.resources.in.datatypes.sms.SMSTPDU.decodeRPMTData
                 @encodeMethod com.opencloud.slee.resources.in.datatypes.sms.SMSTPDU.encodeRPMTData
                 @import com.opencloud.slee.resources.in.datatypes.sms.SMSTPDU
             }
         }
     }
 }
 

Extended in R96.

Used as argument type by MAPOperations.mt_ForwardSM_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
MAPMT_ForwardSM_Arg_v3() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
MAPMT_ForwardSM_Arg_v3	clone() Constructs a copy of this object and everything reachable from it.
static MAPMT_ForwardSM_Arg_v3	copyOf(MAPMT_ForwardSM_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.
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[]	getSmDeliveryStartTime() Gets the value of the field smDeliveryStartTime.
int	getSmDeliveryTimer() Gets the value of the field smDeliveryTimer.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasSmDeliveryStartTime() Tests whether the field smDeliveryStartTime has a value.
boolean	hasSmDeliveryTimer() Tests whether the field smDeliveryTimer has a value.
MAPMT_ForwardSM_Arg_v3	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPMT_ForwardSM_Arg_v3	setMoreMessagesToSendPresent(boolean flag) Sets the presence or absence of the optional field moreMessagesToSend.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPMT_ForwardSM_Arg_v3	setSm_RP_DA(MAPSM_RP_DA value) Sets the value of the field sm-RP-DA.
MAPMT_ForwardSM_Arg_v3	setSm_RP_OA(MAPSM_RP_OA value) Sets the value of the field sm-RP-OA.
MAPMT_ForwardSM_Arg_v3	setSm_RP_UI(SMSTPDU value) Sets the value of the field sm-RP-UI.
MAPMT_ForwardSM_Arg_v3	setSmDeliveryStartTime(byte[] value) Sets the value of the field smDeliveryStartTime.
MAPMT_ForwardSM_Arg_v3	setSmDeliveryTimer(int value) Sets the value of the field smDeliveryTimer and marks the field as present.
MAPMT_ForwardSM_Arg_v3	setSmDeliveryTimerPresent(boolean flag) Sets the presence or absence of the optional field smDeliveryTimer.

Methods inherited from class MAPMT_ForwardSM_Arg_v2

hasMoreMessagesToSend

Methods inherited from class MAPMT_ForwardSM_Arg

getSm_RP_DA, getSm_RP_OA, getSm_RP_UI, hasSm_RP_DA, hasSm_RP_OA, hasSm_RP_UI, setSm_RP_DA

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

MAPMT_ForwardSM_Arg_v3

public MAPMT_ForwardSM_Arg_v3()

Constructs an object with uninitialised state.

Method Detail

clone

public MAPMT_ForwardSM_Arg_v3 clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Overrides:

clone in class MAPMT_ForwardSM_Arg_v2

Returns:

copy of object

copyOf

public static MAPMT_ForwardSM_Arg_v3 copyOf(MAPMT_ForwardSM_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:

MAPMT_ForwardSM_Arg_v3

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.

Overrides:

getFieldsMap in class MAPMT_ForwardSM_Arg_v2

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getSmDeliveryStartTime

public byte[] getSmDeliveryStartTime()

Gets the value of the field smDeliveryStartTime.

Returns:

value of field smDeliveryStartTime, or null if not present

getSmDeliveryTimer

public int getSmDeliveryTimer()

Gets the value of the field smDeliveryTimer.

Returns:

value of field smDeliveryTimer

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasSmDeliveryStartTime

public boolean hasSmDeliveryStartTime()

Tests whether the field smDeliveryStartTime has a value.

Returns:

whether the field smDeliveryStartTime has a value

hasSmDeliveryTimer

public boolean hasSmDeliveryTimer()

Tests whether the field smDeliveryTimer has a value.

Returns:

whether the field smDeliveryTimer has a value

setExtensionContainer

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

setMoreMessagesToSendPresent

public MAPMT_ForwardSM_Arg_v3 setMoreMessagesToSendPresent(boolean flag)
                                                    throws IllegalStateException

Sets the presence or absence of the optional field moreMessagesToSend.

Overrides:

setMoreMessagesToSendPresent in class MAPMT_ForwardSM_Arg_v2

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 MAPMT_ForwardSM_Arg

setSmDeliveryStartTime

public MAPMT_ForwardSM_Arg_v3 setSmDeliveryStartTime(byte[] value)
                                              throws IllegalStateException

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

setSmDeliveryTimer

public MAPMT_ForwardSM_Arg_v3 setSmDeliveryTimer(int value)
                                          throws IllegalStateException

Sets the value of the field smDeliveryTimer and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSmDeliveryTimerPresent

public MAPMT_ForwardSM_Arg_v3 setSmDeliveryTimerPresent(boolean flag)
                                                 throws IllegalStateException

Sets the presence or absence of the optional field smDeliveryTimer.

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

setSm_RP_DA

public MAPMT_ForwardSM_Arg_v3 setSm_RP_DA(MAPSM_RP_DA value)
                                   throws IllegalStateException

Sets the value of the field sm-RP-DA.

Overrides:

setSm_RP_DA in class MAPMT_ForwardSM_Arg_v2

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSm_RP_OA

public MAPMT_ForwardSM_Arg_v3 setSm_RP_OA(MAPSM_RP_OA value)
                                   throws IllegalStateException

Sets the value of the field sm-RP-OA.

Overrides:

setSm_RP_OA in class MAPMT_ForwardSM_Arg_v2

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSm_RP_UI

public MAPMT_ForwardSM_Arg_v3 setSm_RP_UI(SMSTPDU value)
                                   throws IllegalStateException

Sets the value of the field sm-RP-UI.

Overrides:

setSm_RP_UI in class MAPMT_ForwardSM_Arg_v2

Parameters:

value - the new value for the field

Returns:

this

Throws:

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