Package com.opencloud.slee.resources.in.datatypes.sms

Class SMSSubmitReport

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

com.opencloud.slee.resources.in.datatypes.sms.SMSTPDU

com.opencloud.slee.resources.in.datatypes.sms.SMSTPDUWithData

com.opencloud.slee.resources.in.datatypes.sms.SMSSubmitReport

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

SMSSubmitReportAck, SMSSubmitReportError

public abstract class SMSSubmitReport
extends SMSTPDUWithData

Representation of a SMS-SUBMIT-REPORT TPDU. This is the superclass for Ack and Error subclasses that represent the RP-ACK and RP-ERROR variants, respectively.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDUWithData

SMSTPDUWithData.UserDataHeaderIndicator

Nested classes/interfaces inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDU

SMSTPDU.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected SMSTimeStamp	ServiceCentreTimeStamp_value	Value of field ServiceCentreTimeStamp.

Fields inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDUWithData

DataCodingScheme_value, OnlyHeader_present, OnlyHeader_value, ProtocolId_value, UserData_value, UserDataHeaderIndicator_value, UserDataLength_present, UserDataLength_value

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
SMSSubmitReport()	Constructs a new SMSSubmitReport object with no fields set.
SMSSubmitReport(byte[] data)	Constructs a new SMSSubmitReport object from network-encoded data.
SMSSubmitReport(byte[] data, int start, int len)	Constructs a new SMSSubmitReport object from part of network-encoded data.

Method Summary

Modifier and Type	Method	Description
void	checkFieldsSet()	Checks that all mandatory fields are present.
SMSDataCodingScheme	getDataCodingScheme()	Gets the value of the coding scheme within the user data.
SMSProtocolId	getProtocolId()	Gets the value of identifies the above layer protocol.
SMSTimeStamp	getServiceCentreTimeStamp()	Gets the value of time when the SC received the SMSSubmit.
byte[]	getUserData()	Gets the value of the user data.
SMSTPDUWithData.UserDataHeaderIndicator	getUserDataHeaderIndicator()	Gets the value of whether user data contains a header.
int	getUserDataLength()	Gets the value of the length of the user data.
boolean	hasServiceCentreTimeStamp()	Tests whether the field ServiceCentreTimeStamp has a value.
SMSSubmitReport	setDataCodingScheme(SMSDataCodingScheme value)	Sets the value of the coding scheme within the user data.
SMSSubmitReport	setProtocolId(SMSProtocolId value)	Sets the value of identifies the above layer protocol.
void	setReadOnly()	Sets this and all its fields to be immutable.
SMSSubmitReport	setServiceCentreTimeStamp(SMSTimeStamp value)	Sets the value of time when the SC received the SMSSubmit.
SMSSubmitReport	setUserData(byte[] value)	Sets the value of the user data.
SMSSubmitReport	setUserDataHeaderIndicator(SMSTPDUWithData.UserDataHeaderIndicator value)	Sets the value of whether user data contains a header.
SMSSubmitReport	setUserDataLength(int value)	Sets the value of the length of the user data.

Methods inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDUWithData

checkUserDataConstraints, getUserDataHeader, getUserDataString, hasDataCodingScheme, hasOnlyHeader, hasProtocolId, hasUserData, hasUserDataHeaderIndicator, hasUserDataLength, setOnlyHeaderPresent, setUserDataLengthPresent, setUserDataString, setUserDataString, setUserDataString, setUserDataString

Methods inherited from class com.opencloud.slee.resources.in.datatypes.sms.SMSTPDU

decodeRPAck, decodeRPAck, decodeRPError, decodeRPError, decodeRPMOData, decodeRPMOData, decodeRPMTData, decodeRPMTData, encodeRPAck, encodeRPError, encodeRPMOData, encodeRPMTData, getEncodedForm, getType

Methods inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

checkDecode, checkModifyAndDecode, decode, encode

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, getFieldsMap, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, clone, isReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ServiceCentreTimeStamp_value

protected SMSTimeStamp ServiceCentreTimeStamp_value

Value of field ServiceCentreTimeStamp.

Constructor Detail

SMSSubmitReport

public SMSSubmitReport()

Constructs a new SMSSubmitReport object with no fields set.

SMSSubmitReport

public SMSSubmitReport(byte[] data)

Constructs a new SMSSubmitReport object from network-encoded data. The data is not decoded and might not be decodable.

Parameters:

data - network-encoded data

Throws:

NullPointerException - if data is null

SMSSubmitReport

public SMSSubmitReport(byte[] data,
                       int start,
                       int len)

Constructs a new SMSSubmitReport object from part of network-encoded data. The part starts at index start and is len bytes long. The data is not decoded and might not be decodable.

Parameters:

data - network-encoded data

start - starting offset of network-encoded data in byte array

len - default length if not predictable

Throws:

NullPointerException - if data is null

IllegalArgumentException - if len is negative

Method Detail

hasServiceCentreTimeStamp

public boolean hasServiceCentreTimeStamp()
                                  throws DecodeException

Tests whether the field ServiceCentreTimeStamp has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

checkFieldsSet

public void checkFieldsSet()
                    throws EncodeException

Checks that all mandatory fields are present. Should be called immediately before all calls to encode().

Overrides:

checkFieldsSet in class SMSTPDUWithData

Throws:

EncodeException - if any mandatory field is not present

getUserDataHeaderIndicator

public SMSTPDUWithData.UserDataHeaderIndicator getUserDataHeaderIndicator()
                                                                   throws DecodeException

Gets the value of whether user data contains a header.

Overrides:

getUserDataHeaderIndicator in class SMSTPDUWithData

Returns:

UserDataHeaderIndicator representation of whether user data contains a header

Throws:

DecodeException - if encoded state cannot be decoded

getServiceCentreTimeStamp

public SMSTimeStamp getServiceCentreTimeStamp()
                                       throws DecodeException

Gets the value of time when the SC received the SMSSubmit.

Returns:

SMSTimeStamp representation of time when the SC received the SMSSubmit

Throws:

DecodeException - if encoded state cannot be decoded

getProtocolId

public SMSProtocolId getProtocolId()
                            throws DecodeException

Gets the value of identifies the above layer protocol.

Overrides:

getProtocolId in class SMSTPDUWithData

Returns:

SMSProtocolId representation of identifies the above layer protocol

Throws:

DecodeException - if encoded state cannot be decoded

getDataCodingScheme

public SMSDataCodingScheme getDataCodingScheme()
                                        throws DecodeException

Gets the value of the coding scheme within the user data.

Overrides:

getDataCodingScheme in class SMSTPDUWithData

Returns:

SMSDataCodingScheme representation of the coding scheme within the user data

Throws:

DecodeException - if encoded state cannot be decoded

getUserDataLength

public int getUserDataLength()
                      throws DecodeException

Gets the value of the length of the user data.

Overrides:

getUserDataLength in class SMSTPDUWithData

Returns:

int representation of the length of the user data

Throws:

DecodeException - if encoded state cannot be decoded

getUserData

public byte[] getUserData()
                   throws DecodeException

Gets the value of the user data.

Overrides:

getUserData in class SMSTPDUWithData

Returns:

byte[] representation of the user data

Throws:

DecodeException - if encoded state cannot be decoded

setUserDataHeaderIndicator

public SMSSubmitReport setUserDataHeaderIndicator(SMSTPDUWithData.UserDataHeaderIndicator value)
                                           throws IllegalStateException

Sets the value of whether user data contains a header.

Overrides:

setUserDataHeaderIndicator in class SMSTPDUWithData

Parameters:

value - UserDataHeaderIndicator representation of whether user data contains a header

Returns:

this

Throws:

IllegalStateException

setServiceCentreTimeStamp

public SMSSubmitReport setServiceCentreTimeStamp(SMSTimeStamp value)
                                          throws IllegalStateException

Sets the value of time when the SC received the SMSSubmit.

Parameters:

value - SMSTimeStamp representation of time when the SC received the SMSSubmit

Returns:

this

Throws:

IllegalStateException

setProtocolId

public SMSSubmitReport setProtocolId(SMSProtocolId value)
                              throws IllegalStateException

Sets the value of identifies the above layer protocol.

Overrides:

setProtocolId in class SMSTPDUWithData

Parameters:

value - SMSProtocolId representation of identifies the above layer protocol

Returns:

this

Throws:

IllegalStateException

setDataCodingScheme

public SMSSubmitReport setDataCodingScheme(SMSDataCodingScheme value)
                                    throws IllegalStateException

Sets the value of the coding scheme within the user data.

Overrides:

setDataCodingScheme in class SMSTPDUWithData

Parameters:

value - SMSDataCodingScheme representation of the coding scheme within the user data

Returns:

this

Throws:

IllegalStateException

setUserDataLength

public SMSSubmitReport setUserDataLength(int value)
                                  throws IllegalStateException

Sets the value of the length of the user data.

Overrides:

setUserDataLength in class SMSTPDUWithData

Parameters:

value - int representation of the length of the user data

Returns:

this

Throws:

IllegalStateException

setUserData

public SMSSubmitReport setUserData(byte[] value)
                            throws IllegalStateException

Sets the value of the user data.

Overrides:

setUserData in class SMSTPDUWithData

Parameters:

value - byte[] representation of the user data

Returns:

this

Throws:

IllegalStateException

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class SMSTPDUWithData