public interface SmsInformation extends GroupedAvp
7.2.162 SMS-Information AVP The SMS-Information AVP (AVP code 2000) is of type Grouped. Its purpose is to allow the transmission of additional SMS service specific information elements. It has the following ABNF grammar: SMS-Information ::= < AVP Header: 2000> [ SMS-Node ] [ Client-Address ] [ Originator-SCCP-Address ] [ SMSC-Address ] [ Data-Coding-Scheme ] [ SM-Discharge-Time ] [ SM-Message-Type ] [ Originator-Interface ] [ SM-Protocol-ID ] [ Reply-Path-Requested ] [ SM-Status ] [ SM-User-Data-Header ] [ Number-Of-Messages-Sent ] * [ Recipient-Info ] [ Originator-Received-Address ] [ SM-Service-Type ]Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
Address |
getClientAddress()
Returns the value of the Client-Address AVP, of type Address.
|
int |
getDataCodingScheme()
Returns the value of the Data-Coding-Scheme AVP, of type Integer32.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long |
getNumberOfMessagesSent()
Returns the value of the Number-Of-Messages-Sent AVP, of type Unsigned32.
|
OriginatorInterface |
getOriginatorInterface()
Returns the value of the Originator-Interface AVP, of type Grouped.
|
OriginatorReceivedAddress |
getOriginatorReceivedAddress()
Returns the value of the Originator-Received-Address AVP, of type Grouped.
|
Address |
getOriginatorSccpAddress()
Returns the value of the Originator-SCCP-Address AVP, of type Address.
|
RecipientInfo[] |
getRecipientInfos()
Returns the set of Recipient-Info AVPs.
|
ReplyPathRequested |
getReplyPathRequested()
Returns the value of the Reply-Path-Requested AVP, of type Enumerated.
|
java.util.Date |
getSmDischargeTime()
Returns the value of the SM-Discharge-Time AVP, of type Time.
|
SmMessageType |
getSmMessageType()
Returns the value of the SM-Message-Type AVP, of type Enumerated.
|
byte[] |
getSmProtocolId()
Returns the value of the SM-Protocol-ID AVP, of type OctetString.
|
Address |
getSmscAddress()
Returns the value of the SMSC-Address AVP, of type Address.
|
SmServiceType |
getSmServiceType()
Returns the value of the SM-Service-Type AVP, of type Enumerated.
|
SmsNode |
getSmsNode()
Returns the value of the SMS-Node AVP, of type Enumerated.
|
byte[] |
getSmStatus()
Returns the value of the SM-Status AVP, of type OctetString.
|
byte[] |
getSmUserDataHeader()
Returns the value of the SM-User-Data-Header AVP, of type OctetString.
|
boolean |
hasClientAddress()
Returns true if the Client-Address AVP is present in the SMS-Information AVP.
|
boolean |
hasDataCodingScheme()
Returns true if the Data-Coding-Scheme AVP is present in the SMS-Information AVP.
|
boolean |
hasNumberOfMessagesSent()
Returns true if the Number-Of-Messages-Sent AVP is present in the SMS-Information AVP.
|
boolean |
hasOriginatorInterface()
Returns true if the Originator-Interface AVP is present in the SMS-Information AVP.
|
boolean |
hasOriginatorReceivedAddress()
Returns true if the Originator-Received-Address AVP is present in the SMS-Information AVP.
|
boolean |
hasOriginatorSccpAddress()
Returns true if the Originator-SCCP-Address AVP is present in the SMS-Information AVP.
|
boolean |
hasReplyPathRequested()
Returns true if the Reply-Path-Requested AVP is present in the SMS-Information AVP.
|
boolean |
hasSmDischargeTime()
Returns true if the SM-Discharge-Time AVP is present in the SMS-Information AVP.
|
boolean |
hasSmMessageType()
Returns true if the SM-Message-Type AVP is present in the SMS-Information AVP.
|
boolean |
hasSmProtocolId()
Returns true if the SM-Protocol-ID AVP is present in the SMS-Information AVP.
|
boolean |
hasSmscAddress()
Returns true if the SMSC-Address AVP is present in the SMS-Information AVP.
|
boolean |
hasSmServiceType()
Returns true if the SM-Service-Type AVP is present in the SMS-Information AVP.
|
boolean |
hasSmsNode()
Returns true if the SMS-Node AVP is present in the SMS-Information AVP.
|
boolean |
hasSmStatus()
Returns true if the SM-Status AVP is present in the SMS-Information AVP.
|
boolean |
hasSmUserDataHeader()
Returns true if the SM-User-Data-Header AVP is present in the SMS-Information AVP.
|
void |
removeClientAddress()
Removes the Client-Address AVP from the SMS-Information AVP.
|
void |
removeDataCodingScheme()
Removes the Data-Coding-Scheme AVP from the SMS-Information AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the SMS-Information AVP.
|
void |
removeNumberOfMessagesSent()
Removes the Number-Of-Messages-Sent AVP from the SMS-Information AVP.
|
void |
removeOriginatorInterface()
Removes the Originator-Interface AVP from the SMS-Information AVP.
|
void |
removeOriginatorReceivedAddress()
Removes the Originator-Received-Address AVP from the SMS-Information AVP.
|
void |
removeOriginatorSccpAddress()
Removes the Originator-SCCP-Address AVP from the SMS-Information AVP.
|
void |
removeRecipientInfos()
Removes all Recipient-Info AVPs from the SMS-Information AVP.
|
void |
removeReplyPathRequested()
Removes the Reply-Path-Requested AVP from the SMS-Information AVP.
|
void |
removeSmDischargeTime()
Removes the SM-Discharge-Time AVP from the SMS-Information AVP.
|
void |
removeSmMessageType()
Removes the SM-Message-Type AVP from the SMS-Information AVP.
|
void |
removeSmProtocolId()
Removes the SM-Protocol-ID AVP from the SMS-Information AVP.
|
void |
removeSmscAddress()
Removes the SMSC-Address AVP from the SMS-Information AVP.
|
void |
removeSmServiceType()
Removes the SM-Service-Type AVP from the SMS-Information AVP.
|
void |
removeSmsNode()
Removes the SMS-Node AVP from the SMS-Information AVP.
|
void |
removeSmStatus()
Removes the SM-Status AVP from the SMS-Information AVP.
|
void |
removeSmUserDataHeader()
Removes the SM-User-Data-Header AVP from the SMS-Information AVP.
|
void |
setClientAddress(Address clientAddress)
Sets the value of the Client-Address AVP, of type Address.
|
void |
setDataCodingScheme(int dataCodingScheme)
Sets the value of the Data-Coding-Scheme AVP, of type Integer32.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setNumberOfMessagesSent(long numberOfMessagesSent)
Sets the value of the Number-Of-Messages-Sent AVP, of type Unsigned32.
|
void |
setOriginatorInterface(OriginatorInterface originatorInterface)
Sets the value of the Originator-Interface AVP, of type Grouped.
|
void |
setOriginatorReceivedAddress(OriginatorReceivedAddress originatorReceivedAddress)
Sets the value of the Originator-Received-Address AVP, of type Grouped.
|
void |
setOriginatorSccpAddress(Address originatorSccpAddress)
Sets the value of the Originator-SCCP-Address AVP, of type Address.
|
void |
setRecipientInfo(RecipientInfo recipientInfo)
Sets a single Recipient-Info AVP in the SMS-Information AVP, of type Grouped.
|
void |
setRecipientInfos(RecipientInfo[] recipientInfos)
Sets the set of Recipient-Info AVPs, with all the values in the given array.
|
void |
setReplyPathRequested(ReplyPathRequested replyPathRequested)
Sets the value of the Reply-Path-Requested AVP, of type Enumerated.
|
void |
setSmDischargeTime(java.util.Date smDischargeTime)
Sets the value of the SM-Discharge-Time AVP, of type Time.
|
void |
setSmMessageType(SmMessageType smMessageType)
Sets the value of the SM-Message-Type AVP, of type Enumerated.
|
void |
setSmProtocolId(byte[] smProtocolId)
Sets the value of the SM-Protocol-ID AVP, of type OctetString.
|
void |
setSmscAddress(Address smscAddress)
Sets the value of the SMSC-Address AVP, of type Address.
|
void |
setSmServiceType(SmServiceType smServiceType)
Sets the value of the SM-Service-Type AVP, of type Enumerated.
|
void |
setSmsNode(SmsNode smsNode)
Sets the value of the SMS-Node AVP, of type Enumerated.
|
void |
setSmStatus(byte[] smStatus)
Sets the value of the SM-Status AVP, of type OctetString.
|
void |
setSmUserDataHeader(byte[] smUserDataHeader)
Sets the value of the SM-User-Data-Header AVP, of type OctetString.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasSmsNode()
SmsNode getSmsNode()
void setSmsNode(SmsNode smsNode)
java.lang.NullPointerException
- if smsNode
is null
.void removeSmsNode()
boolean hasClientAddress()
Address getClientAddress()
void setClientAddress(Address clientAddress)
java.lang.NullPointerException
- if clientAddress
is null
.void removeClientAddress()
boolean hasOriginatorSccpAddress()
Address getOriginatorSccpAddress()
void setOriginatorSccpAddress(Address originatorSccpAddress)
java.lang.NullPointerException
- if originatorSccpAddress
is null
.void removeOriginatorSccpAddress()
boolean hasSmscAddress()
Address getSmscAddress()
void setSmscAddress(Address smscAddress)
java.lang.NullPointerException
- if smscAddress
is null
.void removeSmscAddress()
boolean hasDataCodingScheme()
int getDataCodingScheme()
hasDataCodingScheme()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Data-Coding-Scheme AVP has not been set.void setDataCodingScheme(int dataCodingScheme)
void removeDataCodingScheme()
boolean hasSmDischargeTime()
java.util.Date getSmDischargeTime()
void setSmDischargeTime(java.util.Date smDischargeTime)
java.lang.NullPointerException
- if smDischargeTime
is null
.void removeSmDischargeTime()
boolean hasSmMessageType()
SmMessageType getSmMessageType()
void setSmMessageType(SmMessageType smMessageType)
java.lang.NullPointerException
- if smMessageType
is null
.void removeSmMessageType()
boolean hasOriginatorInterface()
OriginatorInterface getOriginatorInterface()
void setOriginatorInterface(OriginatorInterface originatorInterface)
java.lang.NullPointerException
- if originatorInterface
is null
.void removeOriginatorInterface()
boolean hasSmProtocolId()
byte[] getSmProtocolId()
void setSmProtocolId(byte[] smProtocolId)
java.lang.NullPointerException
- if smProtocolId
is null
.void removeSmProtocolId()
boolean hasReplyPathRequested()
ReplyPathRequested getReplyPathRequested()
void setReplyPathRequested(ReplyPathRequested replyPathRequested)
java.lang.NullPointerException
- if replyPathRequested
is null
.void removeReplyPathRequested()
boolean hasSmStatus()
byte[] getSmStatus()
void setSmStatus(byte[] smStatus)
java.lang.NullPointerException
- if smStatus
is null
.void removeSmStatus()
boolean hasSmUserDataHeader()
byte[] getSmUserDataHeader()
void setSmUserDataHeader(byte[] smUserDataHeader)
java.lang.NullPointerException
- if smUserDataHeader
is null
.void removeSmUserDataHeader()
boolean hasNumberOfMessagesSent()
long getNumberOfMessagesSent()
hasNumberOfMessagesSent()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Number-Of-Messages-Sent AVP has not been set.void setNumberOfMessagesSent(long numberOfMessagesSent)
void removeNumberOfMessagesSent()
RecipientInfo[] getRecipientInfos()
void setRecipientInfo(RecipientInfo recipientInfo)
java.lang.NullPointerException
- if recipientInfo
is null
.void setRecipientInfos(RecipientInfo[] recipientInfos)
java.lang.NullPointerException
- if recipientInfos
is null
.void removeRecipientInfos()
boolean hasOriginatorReceivedAddress()
OriginatorReceivedAddress getOriginatorReceivedAddress()
void setOriginatorReceivedAddress(OriginatorReceivedAddress originatorReceivedAddress)
java.lang.NullPointerException
- if originatorReceivedAddress
is null
.void removeOriginatorReceivedAddress()
boolean hasSmServiceType()
SmServiceType getSmServiceType()
void setSmServiceType(SmServiceType smServiceType)
java.lang.NullPointerException
- if smServiceType
is null
.void removeSmServiceType()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
AvpNotAllowedException
- if an AVP is encountered of a type already known to this class
(i.e. an AVP for which get/set methods already appear in this class)java.lang.NullPointerException
- if avps
is null
.void removeExtensionAvps()