public interface ImInformation extends GroupedAvp
8.5.6 IM-Information AVP The IM-Information AVP (AVP code 2110) is of type Grouped. Its purpose is to allow the transmission of service information elements used for IM services. <IM-Information> ::= < AVP Header: 2110 > [ Total-Number-Of-Messages-Sent ] [ Total-Number-Of-Messages-Exploded ] [ Number-Of-Messages-Successfully-Sent ] [ Number-Of-Messages-Successfully-Exploded ]Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long |
getNumberOfMessagesSuccessfullyExploded()
Returns the value of the Number-Of-Messages-Successfully-Exploded AVP, of type Unsigned32.
|
long |
getNumberOfMessagesSuccessfullySent()
Returns the value of the Number-Of-Messages-Successfully-Sent AVP, of type Unsigned32.
|
long |
getTotalNumberOfMessagesExploded()
Returns the value of the Total-Number-Of-Messages-Exploded AVP, of type Unsigned32.
|
long |
getTotalNumberOfMessagesSent()
Returns the value of the Total-Number-Of-Messages-Sent AVP, of type Unsigned32.
|
boolean |
hasNumberOfMessagesSuccessfullyExploded()
Returns true if the Number-Of-Messages-Successfully-Exploded AVP is present in the IM-Information AVP.
|
boolean |
hasNumberOfMessagesSuccessfullySent()
Returns true if the Number-Of-Messages-Successfully-Sent AVP is present in the IM-Information AVP.
|
boolean |
hasTotalNumberOfMessagesExploded()
Returns true if the Total-Number-Of-Messages-Exploded AVP is present in the IM-Information AVP.
|
boolean |
hasTotalNumberOfMessagesSent()
Returns true if the Total-Number-Of-Messages-Sent AVP is present in the IM-Information AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the IM-Information AVP.
|
void |
removeNumberOfMessagesSuccessfullyExploded()
Removes the Number-Of-Messages-Successfully-Exploded AVP from the IM-Information AVP.
|
void |
removeNumberOfMessagesSuccessfullySent()
Removes the Number-Of-Messages-Successfully-Sent AVP from the IM-Information AVP.
|
void |
removeTotalNumberOfMessagesExploded()
Removes the Total-Number-Of-Messages-Exploded AVP from the IM-Information AVP.
|
void |
removeTotalNumberOfMessagesSent()
Removes the Total-Number-Of-Messages-Sent AVP from the IM-Information AVP.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setNumberOfMessagesSuccessfullyExploded(long numberOfMessagesSuccessfullyExploded)
Sets the value of the Number-Of-Messages-Successfully-Exploded AVP, of type Unsigned32.
|
void |
setNumberOfMessagesSuccessfullySent(long numberOfMessagesSuccessfullySent)
Sets the value of the Number-Of-Messages-Successfully-Sent AVP, of type Unsigned32.
|
void |
setTotalNumberOfMessagesExploded(long totalNumberOfMessagesExploded)
Sets the value of the Total-Number-Of-Messages-Exploded AVP, of type Unsigned32.
|
void |
setTotalNumberOfMessagesSent(long totalNumberOfMessagesSent)
Sets the value of the Total-Number-Of-Messages-Sent AVP, of type Unsigned32.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasTotalNumberOfMessagesSent()
long getTotalNumberOfMessagesSent()
hasTotalNumberOfMessagesSent()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Total-Number-Of-Messages-Sent AVP has not been set.void setTotalNumberOfMessagesSent(long totalNumberOfMessagesSent)
void removeTotalNumberOfMessagesSent()
boolean hasTotalNumberOfMessagesExploded()
long getTotalNumberOfMessagesExploded()
hasTotalNumberOfMessagesExploded()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Total-Number-Of-Messages-Exploded AVP has not been set.void setTotalNumberOfMessagesExploded(long totalNumberOfMessagesExploded)
void removeTotalNumberOfMessagesExploded()
boolean hasNumberOfMessagesSuccessfullySent()
long getNumberOfMessagesSuccessfullySent()
hasNumberOfMessagesSuccessfullySent()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Number-Of-Messages-Successfully-Sent AVP has not been set.void setNumberOfMessagesSuccessfullySent(long numberOfMessagesSuccessfullySent)
void removeNumberOfMessagesSuccessfullySent()
boolean hasNumberOfMessagesSuccessfullyExploded()
long getNumberOfMessagesSuccessfullyExploded()
hasNumberOfMessagesSuccessfullyExploded()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Number-Of-Messages-Successfully-Exploded AVP has not been set.void setNumberOfMessagesSuccessfullyExploded(long numberOfMessagesSuccessfullyExploded)
void removeNumberOfMessagesSuccessfullyExploded()
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()