public interface GrantedServiceUnit extends GroupedAvp
8.17. Granted-Service-Unit AVP Granted-Service-Unit AVP (AVP Code 431) is of type Grouped and contains the amount of units that the Diameter credit-control client can provide to the end user until the service must be released or the new Credit-Control-Request must be sent. A client is not required to implement all the unit types, and it must treat unknown or unsupported unit types in the answer message as an incorrect CCA answer. In this case, the client MUST terminate the credit-control session and indicate in the Termination-Cause AVP reason DIAMETER_BAD_ANSWER. The Granted-Service-Unit AVP is defined as follows (per the grouped- avp-def of RFC 3588 [DIAMBASE]): Granted-Service-Unit ::= < AVP Header: 431 > [ Tariff-Time-Change ] [ CC-Time ] [ CC-Money ] [ CC-Total-Octets ] [ CC-Input-Octets ] [ CC-Output-Octets ] [ CC-Service-Specific-Units ] *[ AVP ]
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
long |
getCcInputOctets()
Returns the value of the CC-Input-Octets AVP, of type Unsigned64.
|
CcMoney |
getCcMoney()
Returns the value of the CC-Money AVP, of type Grouped.
|
long |
getCcOutputOctets()
Returns the value of the CC-Output-Octets AVP, of type Unsigned64.
|
long |
getCcServiceSpecificUnits()
Returns the value of the CC-Service-Specific-Units AVP, of type Unsigned64.
|
long |
getCcTime()
Returns the value of the CC-Time AVP, of type Unsigned32.
|
long |
getCcTotalOctets()
Returns the value of the CC-Total-Octets AVP, of type Unsigned64.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
java.util.Date |
getTariffTimeChange()
Returns the value of the Tariff-Time-Change AVP, of type Time.
|
boolean |
hasCcInputOctets()
Returns true if the CC-Input-Octets AVP is present in the Granted-Service-Unit AVP.
|
boolean |
hasCcMoney()
Returns true if the CC-Money AVP is present in the Granted-Service-Unit AVP.
|
boolean |
hasCcOutputOctets()
Returns true if the CC-Output-Octets AVP is present in the Granted-Service-Unit AVP.
|
boolean |
hasCcServiceSpecificUnits()
Returns true if the CC-Service-Specific-Units AVP is present in the Granted-Service-Unit AVP.
|
boolean |
hasCcTime()
Returns true if the CC-Time AVP is present in the Granted-Service-Unit AVP.
|
boolean |
hasCcTotalOctets()
Returns true if the CC-Total-Octets AVP is present in the Granted-Service-Unit AVP.
|
boolean |
hasTariffTimeChange()
Returns true if the Tariff-Time-Change AVP is present in the Granted-Service-Unit AVP.
|
void |
removeCcInputOctets()
Removes the CC-Input-Octets AVP from the Granted-Service-Unit AVP.
|
void |
removeCcMoney()
Removes the CC-Money AVP from the Granted-Service-Unit AVP.
|
void |
removeCcOutputOctets()
Removes the CC-Output-Octets AVP from the Granted-Service-Unit AVP.
|
void |
removeCcServiceSpecificUnits()
Removes the CC-Service-Specific-Units AVP from the Granted-Service-Unit AVP.
|
void |
removeCcTime()
Removes the CC-Time AVP from the Granted-Service-Unit AVP.
|
void |
removeCcTotalOctets()
Removes the CC-Total-Octets AVP from the Granted-Service-Unit AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Granted-Service-Unit AVP.
|
void |
removeTariffTimeChange()
Removes the Tariff-Time-Change AVP from the Granted-Service-Unit AVP.
|
void |
setCcInputOctets(long ccInputOctets)
Sets the value of the CC-Input-Octets AVP, of type Unsigned64.
|
void |
setCcMoney(CcMoney ccMoney)
Sets the value of the CC-Money AVP, of type Grouped.
|
void |
setCcOutputOctets(long ccOutputOctets)
Sets the value of the CC-Output-Octets AVP, of type Unsigned64.
|
void |
setCcServiceSpecificUnits(long ccServiceSpecificUnits)
Sets the value of the CC-Service-Specific-Units AVP, of type Unsigned64.
|
void |
setCcTime(long ccTime)
Sets the value of the CC-Time AVP, of type Unsigned32.
|
void |
setCcTotalOctets(long ccTotalOctets)
Sets the value of the CC-Total-Octets AVP, of type Unsigned64.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setTariffTimeChange(java.util.Date tariffTimeChange)
Sets the value of the Tariff-Time-Change AVP, of type Time.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasTariffTimeChange()
java.util.Date getTariffTimeChange()
void setTariffTimeChange(java.util.Date tariffTimeChange)
java.lang.NullPointerException
- if tariffTimeChange
is null
.void removeTariffTimeChange()
boolean hasCcTime()
long getCcTime()
hasCcTime()
to check the existence of this AVP.java.lang.IllegalStateException
- if the CC-Time AVP has not been set.void setCcTime(long ccTime)
void removeCcTime()
boolean hasCcMoney()
CcMoney getCcMoney()
void setCcMoney(CcMoney ccMoney)
java.lang.NullPointerException
- if ccMoney
is null
.void removeCcMoney()
boolean hasCcTotalOctets()
long getCcTotalOctets()
hasCcTotalOctets()
to check the existence of this AVP.java.lang.IllegalStateException
- if the CC-Total-Octets AVP has not been set.void setCcTotalOctets(long ccTotalOctets)
void removeCcTotalOctets()
boolean hasCcInputOctets()
long getCcInputOctets()
hasCcInputOctets()
to check the existence of this AVP.java.lang.IllegalStateException
- if the CC-Input-Octets AVP has not been set.void setCcInputOctets(long ccInputOctets)
void removeCcInputOctets()
boolean hasCcOutputOctets()
long getCcOutputOctets()
hasCcOutputOctets()
to check the existence of this AVP.java.lang.IllegalStateException
- if the CC-Output-Octets AVP has not been set.void setCcOutputOctets(long ccOutputOctets)
void removeCcOutputOctets()
boolean hasCcServiceSpecificUnits()
long getCcServiceSpecificUnits()
hasCcServiceSpecificUnits()
to check the existence of this AVP.java.lang.IllegalStateException
- if the CC-Service-Specific-Units AVP has not been set.void setCcServiceSpecificUnits(long ccServiceSpecificUnits)
void removeCcServiceSpecificUnits()
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()