|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.diameter.charging.util.FinalUnitIndication
public class FinalUnitIndication
FinalUnitIndication is a lightweight representation of the Grouped [Final-Unit-Indication] Avp. The FinalUnitIndication indicates that the GrantedServiceUnit in RoChargingResults contains the final units of quota for the service. The credit-control client is responsible for executing the FinalUnitAction when the quota expires. If the action is REDIRECT, the client can redirect to a Top-Up server to request more quota.
The [Cost-Information] Avp is defined in RFC 4006 - Diameter Credit-Control Application.
Constructor Summary | |
---|---|
FinalUnitIndication()
Constructs an empty FinalUnitIndication object representing the [Final-Unit-Indication] Avp. |
|
FinalUnitIndication(java.util.List<Avp> avps)
Constructs a FinalUnitIndication object representing the Grouped [Final-Unit-Indication] Avp. |
Method Summary | |
---|---|
java.lang.String[] |
getFilterIds()
Gets the value corresponding to the payload of the [Filter-Id] Avp. |
java.lang.Integer |
getFinalUnitAction()
Gets the value corresponding to the payload of the {Final-Unit-Action} Avp. |
RedirectServer |
getRedirectServer()
Gets the value corresponding to the payload of the [Redirect-Server] Avp. |
java.lang.String[] |
getRestrictionFilterRules()
Gets the value corresponding to the payload of the [Restriction-Filter-Rules] Avp. |
void |
setFilterIds(java.lang.String[] filterIds)
Sets the value corresponding to the payload of the [Filter-Id] Avp. |
void |
setFinalUnitAction(java.lang.Integer finalUnitAction)
Sets the value corresponding to the payload of the {Final-Unit-Action} Avp. |
void |
setRedirectServer(RedirectServer redirectServer)
Sets the value corresponding to the payload of the [Redirect-Server] Avp. |
void |
setRestrictionFilterRules(java.lang.String[] restrictionFilterRules)
Sets the value corresponding to the payload of the [Restriction-Filter-Rules] Avp. |
Avp |
toAvp()
Transforms a FinalUnitIndication object into a Grouped [Final-Unit-Indication] Avp. |
void |
validate()
Validates the members of the FinalUnitIndication object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FinalUnitIndication()
public FinalUnitIndication(java.util.List<Avp> avps) throws AvpTransformationException
The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of FinalUnitIndication, 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 Grouped
[Final-Unit-Indication] Avp.
AvpTransformationException
- if the Avp value is in an unexpected format.Method Detail |
---|
public java.lang.String[] getFilterIds()
public void setFilterIds(java.lang.String[] filterIds)
filterIds
- the value corresponding to the payload of the [Filter-Id] Avp.public java.lang.Integer getFinalUnitAction()
public void setFinalUnitAction(java.lang.Integer finalUnitAction)
finalUnitAction
- the value corresponding to the payload of the {Final-Unit-Action} Avp.public RedirectServer getRedirectServer()
public void setRedirectServer(RedirectServer redirectServer)
redirectServer
- the value corresponding to the payload of the [Redirect-Server] Avp.public java.lang.String[] getRestrictionFilterRules()
public void setRestrictionFilterRules(java.lang.String[] restrictionFilterRules)
restrictionFilterRules
- the value corresponding to the payload of the [Restriction-Filter-Rules] Avp.public void validate() throws ChargingValidationException
ChargingValidationException
- if a member of FinalUnitIndication is in an unexpected format.public Avp toAvp() throws AvpTransformationException
All non-null members of FinalUnitIndication will be transformed into Avps nested inside of the [Final-Unit-Indication] Avp.
AvpTransformationException
- if a member of FinalUnitIndication is in an unexpected format.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |