Package com.opencloud.slee.resources.cgin.cap_v4

Class CAP4InitialDPSMSArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP3InitialDPSMSArg

CAP4InitialDPSMSArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4InitialDPSMSArg
extends CAP3InitialDPSMSArg

API for CAP-SMS-ops-args.InitialDPSMSArg. Generated from the following ASN.1 type definition and the adaptations below.

 InitialDPSMSArg ::=
     SEQUENCE {
         serviceKey                  ServiceKey,
         destinationSubscriberNumber CalledPartyBCDNumber OPTIONAL,
         callingPartyNumber          SMS-AddressString OPTIONAL,
         eventTypeSMS                EventTypeSMS OPTIONAL,
         iMSI                        IMSI OPTIONAL,
         locationInformationMSC      LocationInformation OPTIONAL,
         locationInformationGPRS     LocationInformationGPRS OPTIONAL,
         sMSCAddress                 ISDN-AddressString OPTIONAL,
         timeAndTimezone             TimeAndTimezone OPTIONAL,
         tPShortMessageSpecificInfo  TPShortMessageSpecificInfo OPTIONAL,
         tPProtocolIdentifier        TPProtocolIdentifier OPTIONAL,
         tPDataCodingScheme          TPDataCodingScheme OPTIONAL,
         tPValidityPeriod            TPValidityPeriod OPTIONAL,
         extensions                  Extensions OPTIONAL,
         ...
         smsReferenceNumber          CallReferenceNumber OPTIONAL,
         mscAddress                  ISDN-AddressString OPTIONAL,
         sgsn-Number                 ISDN-AddressString OPTIONAL,
         ms-Classmark2               MS-Classmark2 OPTIONAL,
         gPRSMSClass                 GPRSMSClass OPTIONAL,
         iMEI                        IMEI OPTIONAL,
         calledPartyNumber           ISDN-AddressString OPTIONAL
     }
 CAP-SMS-ops-args {
     InitialDPSMSArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v3.CAP3InitialDPSMSArg
         destinationSubscriberNumber {
             @decodeMethod com.opencloud.slee.resources.in.datatypes.cc.CalledPartyBCDNumber.decodeSMSAddress
             @encodeMethod com.opencloud.slee.resources.in.datatypes.cc.CalledPartyBCDNumber.encodeSMSAddress
             @import com.opencloud.slee.resources.in.datatypes.cc.CalledPartyBCDNumber
         }
     }
 }
 

Used as argument type by CAP4Operations.initialDPSMS.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
CAP4InitialDPSMSArg()	Constructs an object with uninitialised state.

Method Summary

Modifier and Type	Method	Description
CAP4InitialDPSMSArg	clone()	Constructs a copy of this object and everything reachable from it.
static CAP4InitialDPSMSArg	copyOf(CAP3InitialDPSMSArg 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.
AddressString	getCalledPartyNumber()	Gets the value of the field calledPartyNumber.
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.
MAPGPRSMSClass	getGPRSMSClass()	Gets the value of the field gPRSMSClass.
IMEIAddress	getIMEI()	Gets the value of the field iMEI.
byte[]	getMs_Classmark2()	Gets the value of the field ms-Classmark2.
byte[]	getTPShortMessageSpecificInfo()	Gets the value of the field tPShortMessageSpecificInfo.
boolean	hasCalledPartyNumber()	Tests whether the field calledPartyNumber has a value.
boolean	hasGPRSMSClass()	Tests whether the field gPRSMSClass has a value.
boolean	hasIMEI()	Tests whether the field iMEI has a value.
boolean	hasMs_Classmark2()	Tests whether the field ms-Classmark2 has a value.
boolean	hasTPShortMessageSpecificInfo()	Tests whether the field tPShortMessageSpecificInfo has a value.
CAP4InitialDPSMSArg	setCalledPartyNumber(AddressString value)	Sets the value of the field calledPartyNumber.
CAP4InitialDPSMSArg	setCallingPartyNumber(AddressString value)	Sets the value of the field callingPartyNumber.
CAP4InitialDPSMSArg	setDestinationSubscriberNumber(CalledPartyBCDNumber value)	Sets the value of the field destinationSubscriberNumber.
CAP4InitialDPSMSArg	setEventTypeSMS(CAP3EventTypeSMS value)	Sets the value of the field eventTypeSMS.
CAP4InitialDPSMSArg	setExtensions(CAP1ExtensionField[] value)	Sets the value of the field extensions.
CAP4InitialDPSMSArg	setGPRSMSClass(MAPGPRSMSClass value)	Sets the value of the field gPRSMSClass.
CAP4InitialDPSMSArg	setIMEI(IMEIAddress value)	Sets the value of the field iMEI.
CAP4InitialDPSMSArg	setIMSI(IMSIAddress value)	Sets the value of the field iMSI.
CAP4InitialDPSMSArg	setLocationInformationGPRS(CAP4LocationInformationGPRS value)	Sets the value of the field locationInformationGPRS.
CAP4InitialDPSMSArg	setLocationInformationMSC(MAPLocationInformation value)	Sets the value of the field locationInformationMSC.
CAP4InitialDPSMSArg	setMs_Classmark2(byte[] value)	Sets the value of the field ms-Classmark2.
CAP4InitialDPSMSArg	setMscAddress(AddressString value)	Sets the value of the field mscAddress.
void	setReadOnly()	Sets this and all its fields to be immutable.
CAP4InitialDPSMSArg	setServiceKey(int value)	Sets the value of the field serviceKey.
CAP4InitialDPSMSArg	setSgsn_Number(AddressString value)	Sets the value of the field sgsn-Number.
CAP4InitialDPSMSArg	setSMSCAddress(AddressString value)	Sets the value of the field sMSCAddress.
CAP4InitialDPSMSArg	setSmsReferenceNumber(byte[] value)	Sets the value of the field smsReferenceNumber.
CAP4InitialDPSMSArg	setTimeAndTimezone(TimeAndTimezone value)	Sets the value of the field timeAndTimezone.
CAP4InitialDPSMSArg	setTPDataCodingScheme(byte[] value)	Sets the value of the field tPDataCodingScheme.
CAP4InitialDPSMSArg	setTPProtocolIdentifier(SMSProtocolId value)	Sets the value of the field tPProtocolIdentifier.
CAP4InitialDPSMSArg	setTPShortMessageSpecificInfo(byte[] value)	Sets the value of the field tPShortMessageSpecificInfo.
CAP4InitialDPSMSArg	setTPValidityPeriod(byte[] value)	Sets the value of the field tPValidityPeriod.

Methods inherited from class com.opencloud.slee.resources.cgin.cap_v3.CAP3InitialDPSMSArg

getCallingPartyNumber, getDestinationSubscriberNumber, getEventTypeSMS, getExtensions, getIMSI, getLocationInformationGPRS, getLocationInformationMSC, getMscAddress, getServiceKey, getSgsn_Number, getSMSCAddress, getSmsReferenceNumber, getTimeAndTimezone, getTPDataCodingScheme, getTPProtocolIdentifier, getTPShortMessageSubmissionInfo, getTPValidityPeriod, hasCallingPartyNumber, hasDestinationSubscriberNumber, hasEventTypeSMS, hasExtensions, hasIMSI, hasLocationInformationGPRS, hasLocationInformationMSC, hasMscAddress, hasServiceKey, hasSgsn_Number, hasSMSCAddress, hasSmsReferenceNumber, hasTimeAndTimezone, hasTPDataCodingScheme, hasTPProtocolIdentifier, hasTPShortMessageSubmissionInfo, hasTPValidityPeriod, setLocationInformationGPRS, setTPShortMessageSubmissionInfo

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

CAP4InitialDPSMSArg

public CAP4InitialDPSMSArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4InitialDPSMSArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP3InitialDPSMSArg

Returns:

copy of object

copyOf

public static CAP4InitialDPSMSArg copyOf(CAP3InitialDPSMSArg 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:

CAP4InitialDPSMSArg

getCalledPartyNumber

public AddressString getCalledPartyNumber()

Gets the value of the field calledPartyNumber.

Returns:

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

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getGPRSMSClass

public MAPGPRSMSClass getGPRSMSClass()

Gets the value of the field gPRSMSClass.

Returns:

value of field gPRSMSClass, or null if not present

getIMEI

public IMEIAddress getIMEI()

Gets the value of the field iMEI.

Returns:

value of field iMEI, or null if not present

getMs_Classmark2

public byte[] getMs_Classmark2()

Gets the value of the field ms-Classmark2.

Returns:

value of field ms-Classmark2, or null if not present

getTPShortMessageSpecificInfo

public byte[] getTPShortMessageSpecificInfo()

Gets the value of the field tPShortMessageSpecificInfo.

Returns:

value of field tPShortMessageSpecificInfo, or null if not present

hasCalledPartyNumber

public boolean hasCalledPartyNumber()

Tests whether the field calledPartyNumber has a value.

Returns:

whether the field calledPartyNumber has a value

hasGPRSMSClass

public boolean hasGPRSMSClass()

Tests whether the field gPRSMSClass has a value.

Returns:

whether the field gPRSMSClass has a value

hasIMEI

public boolean hasIMEI()

Tests whether the field iMEI has a value.

Returns:

whether the field iMEI has a value

hasMs_Classmark2

public boolean hasMs_Classmark2()

Tests whether the field ms-Classmark2 has a value.

Returns:

whether the field ms-Classmark2 has a value

hasTPShortMessageSpecificInfo

public boolean hasTPShortMessageSpecificInfo()

Tests whether the field tPShortMessageSpecificInfo has a value.

Returns:

whether the field tPShortMessageSpecificInfo has a value

setCalledPartyNumber

public CAP4InitialDPSMSArg setCalledPartyNumber(AddressString value)
                                         throws IllegalStateException

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

setCallingPartyNumber

public CAP4InitialDPSMSArg setCallingPartyNumber(AddressString value)
                                          throws IllegalStateException

Sets the value of the field callingPartyNumber. If null, marks the field as absent.

Overrides:

setCallingPartyNumber in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDestinationSubscriberNumber

public CAP4InitialDPSMSArg setDestinationSubscriberNumber(CalledPartyBCDNumber value)
                                                   throws IllegalStateException

Sets the value of the field destinationSubscriberNumber. If null, marks the field as absent.

Overrides:

setDestinationSubscriberNumber in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setEventTypeSMS

public CAP4InitialDPSMSArg setEventTypeSMS(CAP3EventTypeSMS value)
                                    throws IllegalStateException

Sets the value of the field eventTypeSMS. If null, marks the field as absent.

Overrides:

setEventTypeSMS in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP4InitialDPSMSArg setExtensions(CAP1ExtensionField[] value)
                                  throws IllegalStateException

Sets the value of the field extensions. If null, marks the field as absent.

Overrides:

setExtensions in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setGPRSMSClass

public CAP4InitialDPSMSArg setGPRSMSClass(MAPGPRSMSClass value)
                                   throws IllegalStateException

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

setIMEI

public CAP4InitialDPSMSArg setIMEI(IMEIAddress value)
                            throws IllegalStateException

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

setIMSI

public CAP4InitialDPSMSArg setIMSI(IMSIAddress value)
                            throws IllegalStateException

Sets the value of the field iMSI. If null, marks the field as absent.

Overrides:

setIMSI in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setLocationInformationGPRS

public CAP4InitialDPSMSArg setLocationInformationGPRS(CAP4LocationInformationGPRS value)
                                               throws IllegalStateException

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

setLocationInformationMSC

public CAP4InitialDPSMSArg setLocationInformationMSC(MAPLocationInformation value)
                                              throws IllegalStateException

Sets the value of the field locationInformationMSC. If null, marks the field as absent.

Overrides:

setLocationInformationMSC in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setMs_Classmark2

public CAP4InitialDPSMSArg setMs_Classmark2(byte[] value)
                                     throws IllegalStateException

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

setMscAddress

public CAP4InitialDPSMSArg setMscAddress(AddressString value)
                                  throws IllegalStateException

Sets the value of the field mscAddress. If null, marks the field as absent.

Overrides:

setMscAddress in class CAP3InitialDPSMSArg

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 CAP3InitialDPSMSArg

setSMSCAddress

public CAP4InitialDPSMSArg setSMSCAddress(AddressString value)
                                   throws IllegalStateException

Sets the value of the field sMSCAddress. If null, marks the field as absent.

Overrides:

setSMSCAddress in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setServiceKey

public CAP4InitialDPSMSArg setServiceKey(int value)
                                  throws IllegalStateException

Sets the value of the field serviceKey.

Overrides:

setServiceKey in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSgsn_Number

public CAP4InitialDPSMSArg setSgsn_Number(AddressString value)
                                   throws IllegalStateException

Sets the value of the field sgsn-Number. If null, marks the field as absent.

Overrides:

setSgsn_Number in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSmsReferenceNumber

public CAP4InitialDPSMSArg setSmsReferenceNumber(byte[] value)
                                          throws IllegalStateException

Sets the value of the field smsReferenceNumber. If null, marks the field as absent.

Overrides:

setSmsReferenceNumber in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setTPDataCodingScheme

public CAP4InitialDPSMSArg setTPDataCodingScheme(byte[] value)
                                          throws IllegalStateException

Sets the value of the field tPDataCodingScheme. If null, marks the field as absent.

Overrides:

setTPDataCodingScheme in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setTPProtocolIdentifier

public CAP4InitialDPSMSArg setTPProtocolIdentifier(SMSProtocolId value)
                                            throws IllegalStateException

Sets the value of the field tPProtocolIdentifier. If null, marks the field as absent.

Overrides:

setTPProtocolIdentifier in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setTPShortMessageSpecificInfo

public CAP4InitialDPSMSArg setTPShortMessageSpecificInfo(byte[] value)
                                                  throws IllegalStateException

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

setTPValidityPeriod

public CAP4InitialDPSMSArg setTPValidityPeriod(byte[] value)
                                        throws IllegalStateException

Sets the value of the field tPValidityPeriod. If null, marks the field as absent.

Overrides:

setTPValidityPeriod in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setTimeAndTimezone

public CAP4InitialDPSMSArg setTimeAndTimezone(TimeAndTimezone value)
                                       throws IllegalStateException

Sets the value of the field timeAndTimezone. If null, marks the field as absent.

Overrides:

setTimeAndTimezone in class CAP3InitialDPSMSArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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