com.opencloud.slee.resources.cgin.cap_v3

Class CAP3InitialDPSMSArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP3InitialDPSMSArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP4InitialDPSMSArg

public class CAP3InitialDPSMSArg
extends AbstractFieldsObject

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

 InitialDPSMSArg ::=
     SEQUENCE {
         serviceKey                   ServiceKey,
         destinationSubscriberNumber  CalledPartyBCDNumber OPTIONAL,
         callingPartyNumber           ISDN-AddressString OPTIONAL,
         eventTypeSMS                 EventTypeSMS OPTIONAL,
         iMSI                         IMSI OPTIONAL,
         locationInformationMSC       LocationInformation OPTIONAL,
         locationInformationGPRS      LocationInformationGPRS OPTIONAL,
         sMSCAddress                  ISDN-AddressString OPTIONAL,
         timeAndTimezone              TimeAndTimezone OPTIONAL,
         tPShortMessageSubmissionInfo TPShortMessageSubmissionInfo 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
     }
 

Used as argument type by CAP3Operations.initialDPSMS.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP3InitialDPSMSArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP3InitialDPSMSArg	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	getCallingPartyNumber() Gets the value of the field callingPartyNumber.
CalledPartyBCDNumber	getDestinationSubscriberNumber() Gets the value of the field destinationSubscriberNumber.
CAP3EventTypeSMS	getEventTypeSMS() Gets the value of the field eventTypeSMS.
CAP1ExtensionField[]	getExtensions() Gets the value of the field extensions.
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.
IMSIAddress	getIMSI() Gets the value of the field iMSI.
CAP3LocationInformationGPRS	getLocationInformationGPRS() Gets the value of the field locationInformationGPRS.
MAPLocationInformation	getLocationInformationMSC() Gets the value of the field locationInformationMSC.
AddressString	getMscAddress() Gets the value of the field mscAddress.
int	getServiceKey() Gets the value of the field serviceKey.
AddressString	getSgsn_Number() Gets the value of the field sgsn-Number.
AddressString	getSMSCAddress() Gets the value of the field sMSCAddress.
byte[]	getSmsReferenceNumber() Gets the value of the field smsReferenceNumber.
TimeAndTimezone	getTimeAndTimezone() Gets the value of the field timeAndTimezone.
byte[]	getTPDataCodingScheme() Gets the value of the field tPDataCodingScheme.
SMSProtocolId	getTPProtocolIdentifier() Gets the value of the field tPProtocolIdentifier.
byte[]	getTPShortMessageSubmissionInfo() Gets the value of the field tPShortMessageSubmissionInfo.
byte[]	getTPValidityPeriod() Gets the value of the field tPValidityPeriod.
boolean	hasCallingPartyNumber() Tests whether the field callingPartyNumber has a value.
boolean	hasDestinationSubscriberNumber() Tests whether the field destinationSubscriberNumber has a value.
boolean	hasEventTypeSMS() Tests whether the field eventTypeSMS has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasIMSI() Tests whether the field iMSI has a value.
boolean	hasLocationInformationGPRS() Tests whether the field locationInformationGPRS has a value.
boolean	hasLocationInformationMSC() Tests whether the field locationInformationMSC has a value.
boolean	hasMscAddress() Tests whether the field mscAddress has a value.
boolean	hasServiceKey() Tests whether the field serviceKey has a value.
boolean	hasSgsn_Number() Tests whether the field sgsn-Number has a value.
boolean	hasSMSCAddress() Tests whether the field sMSCAddress has a value.
boolean	hasSmsReferenceNumber() Tests whether the field smsReferenceNumber has a value.
boolean	hasTimeAndTimezone() Tests whether the field timeAndTimezone has a value.
boolean	hasTPDataCodingScheme() Tests whether the field tPDataCodingScheme has a value.
boolean	hasTPProtocolIdentifier() Tests whether the field tPProtocolIdentifier has a value.
boolean	hasTPShortMessageSubmissionInfo() Tests whether the field tPShortMessageSubmissionInfo has a value.
boolean	hasTPValidityPeriod() Tests whether the field tPValidityPeriod has a value.
CAP3InitialDPSMSArg	setCallingPartyNumber(AddressString value) Sets the value of the field callingPartyNumber.
CAP3InitialDPSMSArg	setDestinationSubscriberNumber(CalledPartyBCDNumber value) Sets the value of the field destinationSubscriberNumber.
CAP3InitialDPSMSArg	setEventTypeSMS(CAP3EventTypeSMS value) Sets the value of the field eventTypeSMS.
CAP3InitialDPSMSArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP3InitialDPSMSArg	setIMSI(IMSIAddress value) Sets the value of the field iMSI.
CAP3InitialDPSMSArg	setLocationInformationGPRS(CAP3LocationInformationGPRS value) Sets the value of the field locationInformationGPRS.
CAP3InitialDPSMSArg	setLocationInformationMSC(MAPLocationInformation value) Sets the value of the field locationInformationMSC.
CAP3InitialDPSMSArg	setMscAddress(AddressString value) Sets the value of the field mscAddress.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP3InitialDPSMSArg	setServiceKey(int value) Sets the value of the field serviceKey and marks the field as present.
CAP3InitialDPSMSArg	setSgsn_Number(AddressString value) Sets the value of the field sgsn-Number.
CAP3InitialDPSMSArg	setSMSCAddress(AddressString value) Sets the value of the field sMSCAddress.
CAP3InitialDPSMSArg	setSmsReferenceNumber(byte[] value) Sets the value of the field smsReferenceNumber.
CAP3InitialDPSMSArg	setTimeAndTimezone(TimeAndTimezone value) Sets the value of the field timeAndTimezone.
CAP3InitialDPSMSArg	setTPDataCodingScheme(byte[] value) Sets the value of the field tPDataCodingScheme.
CAP3InitialDPSMSArg	setTPProtocolIdentifier(SMSProtocolId value) Sets the value of the field tPProtocolIdentifier.
CAP3InitialDPSMSArg	setTPShortMessageSubmissionInfo(byte[] value) Sets the value of the field tPShortMessageSubmissionInfo.
CAP3InitialDPSMSArg	setTPValidityPeriod(byte[] value) Sets the value of the field tPValidityPeriod.

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

CAP3InitialDPSMSArg

public CAP3InitialDPSMSArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP3InitialDPSMSArg 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 CAP3InitialDPSMSArg 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:

CAP3InitialDPSMSArg

getCallingPartyNumber

public AddressString getCallingPartyNumber()

Gets the value of the field callingPartyNumber.

Returns:

value of field callingPartyNumber, or null if not present

getDestinationSubscriberNumber

public CalledPartyBCDNumber getDestinationSubscriberNumber()

Gets the value of the field destinationSubscriberNumber.

Returns:

value of field destinationSubscriberNumber, or null if not present

getEventTypeSMS

public CAP3EventTypeSMS getEventTypeSMS()

Gets the value of the field eventTypeSMS.

Returns:

value of field eventTypeSMS, or null if not present

getExtensions

public CAP1ExtensionField[] getExtensions()

Gets the value of the field extensions.

Returns:

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

getIMSI

public IMSIAddress getIMSI()

Gets the value of the field iMSI.

Returns:

value of field iMSI, or null if not present

getLocationInformationGPRS

public CAP3LocationInformationGPRS getLocationInformationGPRS()

Gets the value of the field locationInformationGPRS.

Returns:

value of field locationInformationGPRS, or null if not present

getLocationInformationMSC

public MAPLocationInformation getLocationInformationMSC()

Gets the value of the field locationInformationMSC.

Returns:

value of field locationInformationMSC, or null if not present

getMscAddress

public AddressString getMscAddress()

Gets the value of the field mscAddress.

Returns:

value of field mscAddress, or null if not present

getSMSCAddress

public AddressString getSMSCAddress()

Gets the value of the field sMSCAddress.

Returns:

value of field sMSCAddress, or null if not present

getServiceKey

public int getServiceKey()

Gets the value of the field serviceKey.

Returns:

value of field serviceKey

getSgsn_Number

public AddressString getSgsn_Number()

Gets the value of the field sgsn-Number.

Returns:

value of field sgsn-Number, or null if not present

getSmsReferenceNumber

public byte[] getSmsReferenceNumber()

Gets the value of the field smsReferenceNumber.

Returns:

value of field smsReferenceNumber, or null if not present

getTPDataCodingScheme

public byte[] getTPDataCodingScheme()

Gets the value of the field tPDataCodingScheme.

Returns:

value of field tPDataCodingScheme, or null if not present

getTPProtocolIdentifier

public SMSProtocolId getTPProtocolIdentifier()

Gets the value of the field tPProtocolIdentifier.

Returns:

value of field tPProtocolIdentifier, or null if not present

getTPShortMessageSubmissionInfo

public byte[] getTPShortMessageSubmissionInfo()

Gets the value of the field tPShortMessageSubmissionInfo.

Returns:

value of field tPShortMessageSubmissionInfo, or null if not present

getTPValidityPeriod

public byte[] getTPValidityPeriod()

Gets the value of the field tPValidityPeriod.

Returns:

value of field tPValidityPeriod, or null if not present

getTimeAndTimezone

public TimeAndTimezone getTimeAndTimezone()

Gets the value of the field timeAndTimezone.

Returns:

value of field timeAndTimezone, or null if not present

hasCallingPartyNumber

public boolean hasCallingPartyNumber()

Tests whether the field callingPartyNumber has a value.

Returns:

whether the field callingPartyNumber has a value

hasDestinationSubscriberNumber

public boolean hasDestinationSubscriberNumber()

Tests whether the field destinationSubscriberNumber has a value.

Returns:

whether the field destinationSubscriberNumber has a value

hasEventTypeSMS

public boolean hasEventTypeSMS()

Tests whether the field eventTypeSMS has a value.

Returns:

whether the field eventTypeSMS has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasIMSI

public boolean hasIMSI()

Tests whether the field iMSI has a value.

Returns:

whether the field iMSI has a value

hasLocationInformationGPRS

public boolean hasLocationInformationGPRS()

Tests whether the field locationInformationGPRS has a value.

Returns:

whether the field locationInformationGPRS has a value

hasLocationInformationMSC

public boolean hasLocationInformationMSC()

Tests whether the field locationInformationMSC has a value.

Returns:

whether the field locationInformationMSC has a value

hasMscAddress

public boolean hasMscAddress()

Tests whether the field mscAddress has a value.

Returns:

whether the field mscAddress has a value

hasSMSCAddress

public boolean hasSMSCAddress()

Tests whether the field sMSCAddress has a value.

Returns:

whether the field sMSCAddress has a value

hasServiceKey

public boolean hasServiceKey()

Tests whether the field serviceKey has a value.

Returns:

whether the field serviceKey has a value

hasSgsn_Number

public boolean hasSgsn_Number()

Tests whether the field sgsn-Number has a value.

Returns:

whether the field sgsn-Number has a value

hasSmsReferenceNumber

public boolean hasSmsReferenceNumber()

Tests whether the field smsReferenceNumber has a value.

Returns:

whether the field smsReferenceNumber has a value

hasTPDataCodingScheme

public boolean hasTPDataCodingScheme()

Tests whether the field tPDataCodingScheme has a value.

Returns:

whether the field tPDataCodingScheme has a value

hasTPProtocolIdentifier

public boolean hasTPProtocolIdentifier()

Tests whether the field tPProtocolIdentifier has a value.

Returns:

whether the field tPProtocolIdentifier has a value

hasTPShortMessageSubmissionInfo

public boolean hasTPShortMessageSubmissionInfo()

Tests whether the field tPShortMessageSubmissionInfo has a value.

Returns:

whether the field tPShortMessageSubmissionInfo has a value

hasTPValidityPeriod

public boolean hasTPValidityPeriod()

Tests whether the field tPValidityPeriod has a value.

Returns:

whether the field tPValidityPeriod has a value

hasTimeAndTimezone

public boolean hasTimeAndTimezone()

Tests whether the field timeAndTimezone has a value.

Returns:

whether the field timeAndTimezone has a value

setCallingPartyNumber

public CAP3InitialDPSMSArg setCallingPartyNumber(AddressString value)
                                          throws IllegalStateException

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

setDestinationSubscriberNumber

public CAP3InitialDPSMSArg setDestinationSubscriberNumber(CalledPartyBCDNumber value)
                                                   throws IllegalStateException

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

setEventTypeSMS

public CAP3InitialDPSMSArg setEventTypeSMS(CAP3EventTypeSMS value)
                                    throws IllegalStateException

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

setExtensions

public CAP3InitialDPSMSArg setExtensions(CAP1ExtensionField[] value)
                                  throws IllegalStateException

Sets the value of the field extensions. 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 CAP3InitialDPSMSArg setIMSI(IMSIAddress value)
                            throws IllegalStateException

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

setLocationInformationGPRS

public CAP3InitialDPSMSArg setLocationInformationGPRS(CAP3LocationInformationGPRS 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 CAP3InitialDPSMSArg setLocationInformationMSC(MAPLocationInformation value)
                                              throws IllegalStateException

Sets the value of the field locationInformationMSC. 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 CAP3InitialDPSMSArg setMscAddress(AddressString value)
                                  throws IllegalStateException

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

setSMSCAddress

public CAP3InitialDPSMSArg setSMSCAddress(AddressString value)
                                   throws IllegalStateException

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

setServiceKey

public CAP3InitialDPSMSArg setServiceKey(int value)
                                  throws IllegalStateException

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

setSgsn_Number

public CAP3InitialDPSMSArg setSgsn_Number(AddressString value)
                                   throws IllegalStateException

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

setSmsReferenceNumber

public CAP3InitialDPSMSArg setSmsReferenceNumber(byte[] value)
                                          throws IllegalStateException

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

setTPDataCodingScheme

public CAP3InitialDPSMSArg setTPDataCodingScheme(byte[] value)
                                          throws IllegalStateException

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

setTPProtocolIdentifier

public CAP3InitialDPSMSArg setTPProtocolIdentifier(SMSProtocolId value)
                                            throws IllegalStateException

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

setTPShortMessageSubmissionInfo

public CAP3InitialDPSMSArg setTPShortMessageSubmissionInfo(byte[] value)
                                                    throws IllegalStateException

Sets the value of the field tPShortMessageSubmissionInfo. 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 CAP3InitialDPSMSArg setTPValidityPeriod(byte[] value)
                                        throws IllegalStateException

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

setTimeAndTimezone

public CAP3InitialDPSMSArg setTimeAndTimezone(TimeAndTimezone value)
                                       throws IllegalStateException

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