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

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 Subinterfaces:
UsedServiceUnitAvp
All Known Implementing Classes:
RequestedServiceUnitAvpImpl, UsedServiceUnitAvpImpl

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

  <b>8.18. Requested-Service-Unit AVP</b>
 
 
   The Requested-Service-Unit AVP (AVP Code 437) is of type Grouped and
   contains the amount of requested units specified by the Diameter
   credit-control client.  A server is not required to implement all the
   unit types, and it must treat unknown or unsupported unit types as
   invalid AVPs.
 
   The Requested-Service-Unit AVP is defined as follows (per the
   grouped-avp-def of RFC 3588 [DIAMBASE]):
 
      Requested-Service-Unit ::= < AVP Header: 437 >
                                 [ CC-Time ]
                                 [ CC-Money ]
                                 [ CC-Total-Octets ]
                                 [ CC-Input-Octets ]
                                 [ CC-Output-Octets ]
                                 [ CC-Service-Specific-Units ]
                                *[ AVP ]
 

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
 long getCreditControlInputOctets()
          Returns the value of the CC-Input-Octets AVP, of type Unsigned64.
 CcMoneyAvp getCreditControlMoneyAvp()
          Returns the value of the CC-Money AVP, of type Grouped.
 long getCreditControlOutputOctets()
          Returns the value of the CC-Output-Octets AVP, of type Unsigned64.
 long getCreditControlServiceSpecificUnits()
          Returns the value of the CC-Service-Specific-Units AVP, of type Unsigned64.
 long getCreditControlTime()
          Returns the value of the CC-Time AVP, of type Unsigned32.
 long getCreditControlTotalOctets()
          Returns the value of the CC-Total-Octets AVP, of type Unsigned64.
 boolean hasCreditControlInputOctets()
          Returns true if the CC-Input-Octets AVP is present in the message.
 boolean hasCreditControlMoneyAvp()
          Returns true if the CC-Money AVP is present in the message.
 boolean hasCreditControlOutputOctets()
          Returns true if the CC-Output-Octets AVP is present in the message.
 boolean hasCreditControlServiceSpecificUnits()
          Returns true if the CC-Service-Specific-Units AVP is present in the message.
 boolean hasCreditControlTime()
          Returns true if the CC-Time AVP is present in the message.
 boolean hasCreditControlTotalOctets()
          Returns true if the CC-Total-Octets AVP is present in the message.
 void setCreditControlInputOctets(long ttc)
          Sets the value of the CC-Input-Octets AVP, of type Unsigned64.
 void setCreditControlMoneyAvp(CcMoneyAvp ccm)
          Sets the value of the CC-Money AVP, of type Grouped.
 void setCreditControlOutputOctets(long ccoo)
          Sets the value of the CC-Output-Octets AVP, of type Unsigned64.
 void setCreditControlServiceSpecificUnits(long ccssu)
          Sets the value of the CC-Service-Specific-Units AVP, of type Unsigned64.
 void setCreditControlTime(long cct)
          Sets the value of the CC-Time AVP, of type Unsigned32.
 void setCreditControlTotalOctets(long ccto)
          Sets the value of the CC-Total-Octets AVP, of type Unsigned64.
 
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

setCreditControlMoneyAvp

void setCreditControlMoneyAvp(CcMoneyAvp ccm)
Sets the value of the CC-Money AVP, of type Grouped.
See: CcMoneyAvp

Parameters:
ccm -

getCreditControlMoneyAvp

CcMoneyAvp getCreditControlMoneyAvp()
Returns the value of the CC-Money AVP, of type Grouped. A return value of null implies that the AVP has not been set.
See: CcMoneyAvp

Returns:

hasCreditControlMoneyAvp

boolean hasCreditControlMoneyAvp()
Returns true if the CC-Money AVP is present in the message.

Returns:

setCreditControlTotalOctets

void setCreditControlTotalOctets(long ccto)
Sets the value of the CC-Total-Octets AVP, of type Unsigned64.

Parameters:
ccto -

getCreditControlTotalOctets

long getCreditControlTotalOctets()
Returns the value of the CC-Total-Octets AVP, of type Unsigned64.

Returns:

hasCreditControlTotalOctets

boolean hasCreditControlTotalOctets()
Returns true if the CC-Total-Octets AVP is present in the message.

Returns:

setCreditControlInputOctets

void setCreditControlInputOctets(long ttc)
Sets the value of the CC-Input-Octets AVP, of type Unsigned64.

Parameters:
ttc -

getCreditControlInputOctets

long getCreditControlInputOctets()
Returns the value of the CC-Input-Octets AVP, of type Unsigned64.

Returns:

hasCreditControlInputOctets

boolean hasCreditControlInputOctets()
Returns true if the CC-Input-Octets AVP is present in the message.

Returns:

setCreditControlOutputOctets

void setCreditControlOutputOctets(long ccoo)
Sets the value of the CC-Output-Octets AVP, of type Unsigned64.

Parameters:
ccoo -

getCreditControlOutputOctets

long getCreditControlOutputOctets()
Returns the value of the CC-Output-Octets AVP, of type Unsigned64.

Returns:

hasCreditControlOutputOctets

boolean hasCreditControlOutputOctets()
Returns true if the CC-Output-Octets AVP is present in the message.

Returns:

setCreditControlTime

void setCreditControlTime(long cct)
Sets the value of the CC-Time AVP, of type Unsigned32.

Parameters:
cct -

getCreditControlTime

long getCreditControlTime()
Returns the value of the CC-Time AVP, of type Unsigned32.

Returns:

hasCreditControlTime

boolean hasCreditControlTime()
Returns true if the CC-Time AVP is present in the message.

Returns:

setCreditControlServiceSpecificUnits

void setCreditControlServiceSpecificUnits(long ccssu)
Sets the value of the CC-Service-Specific-Units AVP, of type Unsigned64.

Parameters:
ccssu -

getCreditControlServiceSpecificUnits

long getCreditControlServiceSpecificUnits()
Returns the value of the CC-Service-Specific-Units AVP, of type Unsigned64.

Returns:

hasCreditControlServiceSpecificUnits

boolean hasCreditControlServiceSpecificUnits()
Returns true if the CC-Service-Specific-Units AVP is present in the message.

Returns:


Copyright © 2012. All Rights Reserved.