net.java.slee.resource.diameter.cca.events.avp
Interface GSUPoolReferenceAvp

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.avp.DiameterAvp, net.java.slee.resource.diameter.base.events.avp.GroupedAvp

All Known Implementing Classes:

GSUPoolReferenceAvpImpl

public interface GSUPoolReferenceAvp
extends net.java.slee.resource.diameter.base.events.avp.GroupedAvp

  <b>8.30. G-S-U-Pool-Reference AVP</b>
 
 
   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 }
 

Author:

Bartosz Baranowski , Alexandre Mendonca

Field Summary

Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT

Method Summary

CcUnitType	getCreditControlUnitType() Returns the value of the CC-Unit-Type AVP, of type Enumerated.
long	getGSUPoolIdentifier() Returns the value of the G-S-U-Pool-Identifier AVP, of type Unsigned32.
UnitValueAvp	getUnitValue() Returns the value of the Unit-Value AVP, of type Grouped.
boolean	hasCreditControlUnitType() Returns true if the CC-Unit-Type AVP is present in the message.
boolean	hasGSUPoolIdentifier() Returns true if the G-S-U-Pool-Identifier AVP is present in the message.
boolean	hasUnitValue() Returns true if the Unit-Value AVP is present in the message.
void	setCreditControlUnitType(CcUnitType ccUnitType) Sets the value of the CC-Unit-Type AVP, of type Enumerated.
void	setGSUPoolIdentifier(long gsuPoolIdentifier) Sets the value of the G-S-U-Pool-Identifier AVP, of type Unsigned32.
void	setUnitValue(UnitValueAvp unitValue) Sets the value of the Unit-Value AVP, of type Grouped.

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp

getExtensionAvps, setExtensionAvps

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, octetStringValue, stringValue

Method Detail

getCreditControlUnitType

CcUnitType getCreditControlUnitType()

Returns the value of the CC-Unit-Type AVP, of type Enumerated.
See: CcUnitType.

Returns:

getGSUPoolIdentifier

long getGSUPoolIdentifier()

Returns the value of the G-S-U-Pool-Identifier AVP, of type Unsigned32.

Returns:

getUnitValue

UnitValueAvp getUnitValue()

Returns the value of the Unit-Value AVP, of type Grouped.

Returns:

hasCreditControlUnitType

boolean hasCreditControlUnitType()

Returns true if the CC-Unit-Type AVP is present in the message.

Returns:

hasGSUPoolIdentifier

boolean hasGSUPoolIdentifier()

Returns true if the G-S-U-Pool-Identifier AVP is present in the message.

Returns:

hasUnitValue

boolean hasUnitValue()

Returns true if the Unit-Value AVP is present in the message.

Returns:

setCreditControlUnitType

void setCreditControlUnitType(CcUnitType ccUnitType)

Sets the value of the CC-Unit-Type AVP, of type Enumerated.
See: CcUnitType.

Parameters:

ccUnitType -

setGSUPoolIdentifier

void setGSUPoolIdentifier(long gsuPoolIdentifier)

Sets the value of the G-S-U-Pool-Identifier AVP, of type Unsigned32.

Parameters:

gsuPoolIdentifier -

setUnitValue

void setUnitValue(UnitValueAvp unitValue)

Sets the value of the Unit-Value AVP, of type Grouped.
See

Parameters:

unitValue -