|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.diameter.charging.util.RfAccountingResults
public class RfAccountingResults
The RfAccountingResults class is a simple representation of the Diameter Accounting Answer (ACA) command. It contains all the pertinent information returned by the CCF that an accounting client needs to manage an Accounting session.
The ACA command is defined in RFC 3588 - Diameter Base Protocol.
Constructor Summary | |
---|---|
RfAccountingResults()
Constructs an empty RfAccountingResults object representing the ACA Command. |
|
RfAccountingResults(java.util.List<Avp> avps)
Constructs a RfAccountingResults object representing the ACA Command. |
Method Summary | |
---|---|
java.lang.Integer |
getAcctInterimInterval()
Gets the value corresponding to the payload of the [Acct-Interim-Interval] Avp. |
java.lang.Long |
getEventTimestamp()
Gets the value corresponding to the payload of the [Event-Timestamp] Avp. |
java.lang.Integer |
getOriginStateId()
Gets the value corresponding to the payload of the [Origin-State-Id] Avp. |
java.lang.Integer |
getResultCode()
Gets the value corresponding to the payload of the {Result-Code} Avp. |
void |
setAcctInterimInterval(java.lang.Integer acctInterimInterval)
Sets the value corresponding to the payload of the [Acct-Interim-Interval] Avp. |
void |
setEventTimestamp(java.lang.Long eventTimestamp)
Sets the value corresponding to the payload of the [Event-Timestamp] Avp. |
void |
setOriginStateId(java.lang.Integer originStateId)
Sets the value corresponding to the payload of the [Origin-State-Id] Avp. |
void |
setResultCode(java.lang.Integer resultCode)
Sets the value corresponding to the payload of the {Result-Code} Avp. |
java.util.Vector |
toAvps()
Transforms the RfAccountingResults object into a Vector of Avps. |
void |
validate()
Validates the members of the RoChargingResults object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RfAccountingResults()
public RfAccountingResults(java.util.List<Avp> avps)
The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of RfAccountingResults, the member will be populated with the Avp value during construction. If an Avp code is unknown, the value will be silently discarded.
avps
- a list of Avps that can appear in the ACA
AvpTransformationException
- if the Avp value is in an unexpected format.Method Detail |
---|
public java.lang.Integer getAcctInterimInterval()
The omission of this value or its inclusion with Value field set to 0 means that EVENT_RECORD, START_RECORD,and STOP_RECORD are produced, as appropriate for the service. The inclusion of the Value set to a non-zero value means that INTERIM_RECORD records MUST be produced between the START_RECORD and STOP_RECORD records. [Acct-Interim-Interval]
public void setAcctInterimInterval(java.lang.Integer acctInterimInterval)
acctInterimInterval
- the value corresponding to the payload of the [Acct-Interim-Interval] Avp.public java.lang.Long getEventTimestamp()
The event time stamp is defined as the difference in milliseconds between the current time and midnight, January 1, 1970 UTC.
public void setEventTimestamp(java.lang.Long eventTimestamp)
eventTimestamp
- the value corresponding to the payload of the [Event-Timestamp] Avp.public java.lang.Integer getOriginStateId()
This is a monotonically increasing value that is advanced whenever a Diameter entity restarts with loss of previous state, for example upon reboot. A Diameter entity issuing it MUST create a higher value each time its state is reset. A Diameter entity MAY set it to the time of startup, or it MAY use an incrementing counter retained in non-volatile memory across restarts. [Origin-State-Id]
public void setOriginStateId(java.lang.Integer originStateId)
originStateId
- the value corresponding to the payload of the [Origin-State-Id] Avp.public java.lang.Integer getResultCode()
It holds either 2001 (DIAMETER_SUCCESS) or 2002 (DIAMETER_LIMITED_SUCCESS). Error conditions will be reported via Exceptions.
public void setResultCode(java.lang.Integer resultCode)
resultCode
- the value corresponding to the payload of the {Result-Code} Avp.public void validate() throws ChargingValidationException
ChargingValidationException
- if a member of RoChargingResults is in an unexpected format.public java.util.Vector toAvps()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |