public interface GsuPoolReference extends GroupedAvp
8.30. G-S-U-Pool-Reference AVP The G-S-U-Pool-Reference AVP (AVP Code 457) is of type Grouped. It is used in the Credit-Control-Answer message, and associates the Granted-Service-Unit AVP within which it appears with a credit pool within the session. The G-S-U-Pool-Identifier AVP specifies the credit pool from which credit is drawn for this unit type. The CC-Unit-Type AVP specifies the type of units for which credit is pooled. The Unit-Value AVP specifies the multiplier, which converts between service units of type CC-Unit-Type and abstract service units within the credit pool (and thus to service units of any other service or rating group associated with the same pool). The G-S-U-Pool-Reference AVP is defined as follows (per the grouped- avp-def of RFC 3588 [DIAMBASE]): G-S-U-Pool-Reference ::= < AVP Header: 457 > { G-S-U-Pool-Identifier } { CC-Unit-Type } { Unit-Value }Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
CcUnitType |
getCcUnitType()
Returns the value of the CC-Unit-Type AVP, of type Enumerated.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long |
getGsuPoolIdentifier()
Returns the value of the G-S-U-Pool-Identifier AVP, of type Unsigned32.
|
UnitValue |
getUnitValue()
Returns the value of the Unit-Value AVP, of type Grouped.
|
boolean |
hasCcUnitType()
Returns true if the CC-Unit-Type AVP is present in the G-S-U-Pool-Reference AVP.
|
boolean |
hasGsuPoolIdentifier()
Returns true if the G-S-U-Pool-Identifier AVP is present in the G-S-U-Pool-Reference AVP.
|
boolean |
hasUnitValue()
Returns true if the Unit-Value AVP is present in the G-S-U-Pool-Reference AVP.
|
void |
removeCcUnitType()
Removes the CC-Unit-Type AVP from the G-S-U-Pool-Reference AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the G-S-U-Pool-Reference AVP.
|
void |
removeGsuPoolIdentifier()
Removes the G-S-U-Pool-Identifier AVP from the G-S-U-Pool-Reference AVP.
|
void |
removeUnitValue()
Removes the Unit-Value AVP from the G-S-U-Pool-Reference AVP.
|
void |
setCcUnitType(CcUnitType ccUnitType)
Sets the value of the CC-Unit-Type AVP, of type Enumerated.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setGsuPoolIdentifier(long gsuPoolIdentifier)
Sets the value of the G-S-U-Pool-Identifier AVP, of type Unsigned32.
|
void |
setUnitValue(UnitValue unitValue)
Sets the value of the Unit-Value AVP, of type Grouped.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasGsuPoolIdentifier()
long getGsuPoolIdentifier()
hasGsuPoolIdentifier()
to check the existence of this AVP.java.lang.IllegalStateException
- if the G-S-U-Pool-Identifier AVP has not been set.void setGsuPoolIdentifier(long gsuPoolIdentifier)
void removeGsuPoolIdentifier()
boolean hasCcUnitType()
CcUnitType getCcUnitType()
void setCcUnitType(CcUnitType ccUnitType)
java.lang.NullPointerException
- if ccUnitType
is null
.void removeCcUnitType()
boolean hasUnitValue()
UnitValue getUnitValue()
void setUnitValue(UnitValue unitValue)
java.lang.NullPointerException
- if unitValue
is null
.void removeUnitValue()
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()