public interface Envelope extends GroupedAvp
7.2.59 Envelope AVP The Envelope AVP (AVP code 1266) is a grouped AVP which reports the start and end time of one time envelope using the Envelope-Start-Time and Envelope-End-Time AVPs. Further details of its usage are described in clause 6.5.6 and 6.5.7. If an envelope has not been closed at the time of the usage report, then the Envelope-End-Time AVP shall be absent. If an envelope was started before the reporting interval then the Envelope-Start-Time is nevertheless present and contains the same time as previously reported, i.e. the actual time of the start of the envelope. The client shall include the volume reports (the CC-xxxxx-Octets AVPs) or events (CC-Service-Specific-Units) if these were requested in the corresponding Envelope-Reporting AVP. The reported volume is always the volume from the beginning of the time envelope. In circumstances, in which an envelope is retrospectively deemed to have been closed, e.g. with Quota-Consumption- Time changes in a CCA, then the client shall include the Envelope-AVP for the envelope in the next usage report. Multiple occurrences of this AVP shall be in chronological order, i.e. the first envelope is listed first in CCR. Envelope ::= < AVP Header: 1266> { Envelope-Start-Time } [ Envelope-End-Time ] [ 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.
|
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 |
getCcTotalOctets()
Returns the value of the CC-Total-Octets AVP, of type Unsigned64.
|
java.util.Date |
getEnvelopeEndTime()
Returns the value of the Envelope-End-Time AVP, of type Time.
|
java.util.Date |
getEnvelopeStartTime()
Returns the value of the Envelope-Start-Time AVP, of type Time.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
boolean |
hasCcInputOctets()
Returns true if the CC-Input-Octets AVP is present in the Envelope AVP.
|
boolean |
hasCcOutputOctets()
Returns true if the CC-Output-Octets AVP is present in the Envelope AVP.
|
boolean |
hasCcServiceSpecificUnits()
Returns true if the CC-Service-Specific-Units AVP is present in the Envelope AVP.
|
boolean |
hasCcTotalOctets()
Returns true if the CC-Total-Octets AVP is present in the Envelope AVP.
|
boolean |
hasEnvelopeEndTime()
Returns true if the Envelope-End-Time AVP is present in the Envelope AVP.
|
boolean |
hasEnvelopeStartTime()
Returns true if the Envelope-Start-Time AVP is present in the Envelope AVP.
|
void |
removeCcInputOctets()
Removes the CC-Input-Octets AVP from the Envelope AVP.
|
void |
removeCcOutputOctets()
Removes the CC-Output-Octets AVP from the Envelope AVP.
|
void |
removeCcServiceSpecificUnits()
Removes the CC-Service-Specific-Units AVP from the Envelope AVP.
|
void |
removeCcTotalOctets()
Removes the CC-Total-Octets AVP from the Envelope AVP.
|
void |
removeEnvelopeEndTime()
Removes the Envelope-End-Time AVP from the Envelope AVP.
|
void |
removeEnvelopeStartTime()
Removes the Envelope-Start-Time AVP from the Envelope AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Envelope AVP.
|
void |
setCcInputOctets(long ccInputOctets)
Sets the value of the CC-Input-Octets AVP, of type Unsigned64.
|
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 |
setCcTotalOctets(long ccTotalOctets)
Sets the value of the CC-Total-Octets AVP, of type Unsigned64.
|
void |
setEnvelopeEndTime(java.util.Date envelopeEndTime)
Sets the value of the Envelope-End-Time AVP, of type Time.
|
void |
setEnvelopeStartTime(java.util.Date envelopeStartTime)
Sets the value of the Envelope-Start-Time AVP, of type Time.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasEnvelopeStartTime()
java.util.Date getEnvelopeStartTime()
void setEnvelopeStartTime(java.util.Date envelopeStartTime)
java.lang.NullPointerException
- if envelopeStartTime
is null
.void removeEnvelopeStartTime()
boolean hasEnvelopeEndTime()
java.util.Date getEnvelopeEndTime()
void setEnvelopeEndTime(java.util.Date envelopeEndTime)
java.lang.NullPointerException
- if envelopeEndTime
is null
.void removeEnvelopeEndTime()
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()