Interface RealTimeTariffInformation
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface RealTimeTariffInformation extends GroupedAvp
Defines an interface representing the Real-Time-Tariff-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification:7.2.164 Real-Time-Tariff-Information AVP The Real-Time-Tariff-Information AVP (AVP code 2305) is of type Grouped and holds the tariff information received in real time according to TSĀ 29.658 [222] in the SIP signalling. It has the following ABNF grammar: Real-Time-Tariff-Information ::= < AVP Header: 2305 > [ Tariff-Information ] [ Tariff-XML ]
Note:
The support for extension AVPs is present even thou the ABNF grammar for this AVP does not contain the "* [ AVP ]" line. Be aware that adding any extension AVPs may result in interoperability problems with products that strongly validate the incoming diameter message for it's adherence to the specification.
-
-
Field Summary
-
Fields inherited from interface org.jainslee.resources.diameter.base.DiameterAvp
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DiameterAvp[]
getExtensionAvps()
Returns the set of extension AVPs.TariffInformation
getTariffInformation()
Returns the value of the Tariff-Information AVP, of type Grouped.String
getTariffXml()
Returns the value of the Tariff-XML AVP, of type UTF8String.boolean
hasTariffInformation()
Returns true if the Tariff-Information AVP is present in the Real-Time-Tariff-Information AVP.boolean
hasTariffXml()
Returns true if the Tariff-XML AVP is present in the Real-Time-Tariff-Information AVP.void
removeExtensionAvps()
Removes all extension AVPs from the Real-Time-Tariff-Information AVP.void
removeTariffInformation()
Removes the Tariff-Information AVP from the Real-Time-Tariff-Information AVP.void
removeTariffXml()
Removes the Tariff-XML AVP from the Real-Time-Tariff-Information AVP.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setTariffInformation(TariffInformation tariffInformation)
Sets the value of the Tariff-Information AVP, of type Grouped.void
setTariffXml(String tariffXml)
Sets the value of the Tariff-XML AVP, of type UTF8String.-
Methods inherited from interface org.jainslee.resources.diameter.base.DiameterAvp
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
-
-
-
-
Method Detail
-
hasTariffInformation
boolean hasTariffInformation()
Returns true if the Tariff-Information AVP is present in the Real-Time-Tariff-Information AVP.
-
getTariffInformation
TariffInformation getTariffInformation()
Returns the value of the Tariff-Information AVP, of type Grouped.- Returns:
- the value of the Tariff-Information AVP, or null if it has not been set.
-
setTariffInformation
void setTariffInformation(TariffInformation tariffInformation)
Sets the value of the Tariff-Information AVP, of type Grouped.- Throws:
NullPointerException
- iftariffInformation
isnull
.
-
removeTariffInformation
void removeTariffInformation()
Removes the Tariff-Information AVP from the Real-Time-Tariff-Information AVP. If the Tariff-Information AVP is not present, this method returns silently.
-
hasTariffXml
boolean hasTariffXml()
Returns true if the Tariff-XML AVP is present in the Real-Time-Tariff-Information AVP.
-
getTariffXml
String getTariffXml()
Returns the value of the Tariff-XML AVP, of type UTF8String.- Returns:
- the value of the Tariff-XML AVP, or null if it has not been set.
-
setTariffXml
void setTariffXml(String tariffXml)
Sets the value of the Tariff-XML AVP, of type UTF8String.- Throws:
NullPointerException
- iftariffXml
isnull
.
-
removeTariffXml
void removeTariffXml()
Removes the Tariff-XML AVP from the Real-Time-Tariff-Information AVP. If the Tariff-XML AVP is not present, this method returns silently.
-
getExtensionAvps
DiameterAvp[] getExtensionAvps()
Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the Real-Time-Tariff-Information AVP. A return value of null implies that no extensions AVPs have been set.
-
setExtensionAvps
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to Real-Time-Tariff-Information AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.- Throws:
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)NullPointerException
- ifavps
isnull
.
-
removeExtensionAvps
void removeExtensionAvps()
Removes all extension AVPs from the Real-Time-Tariff-Information AVP. If no extension AVPs are present, this method returns silently.
-
-