com.ibm.diameter.charging.util
Class LocationType

java.lang.Object
  extended by com.ibm.diameter.charging.util.LocationType

public class LocationType
extends java.lang.Object

LocationType is a lightweight representation of the Grouped [Location-Type] Avp. It indicates the type of location estimate required by the LCS Client.

The [Location-Type] Avp is defined by the 3GPP in ETSI TS 132 299 V6.9.0 (2006-12) - Diameter charging applications.


Constructor Summary
LocationType()
          Constructs an empty LocationType object representing the [Location-Type] Avp.
LocationType(java.util.List<Avp> avps)
          Constructs a LocationType object representing the Grouped [Location-Type] Avp.
 
Method Summary
 java.lang.String getDeferredLocationEventType()
          Gets the value corresponding to the payload of the [Deferrred-Location-Event-Type] Avp.
 java.lang.Integer getLocationEstimateType()
          Gets the value corresponding to the payload of the [Location-Estimate-Type] Avp.
 void setDeferredLocationEventType(java.lang.String deferredLocationEventType)
          Sets the value corresponding to the payload of the [Deferrred-Location-Event-Type] Avp.
 void setLocationEstimateType(java.lang.Integer locationEstimateType)
          Sets the value corresponding to the payload of the [Location-Estimate-Type] Avp.
 Avp toAvp()
          Transforms a LocationType object into a Grouped [Location-Type] Avp.
 void validate()
          Validates the members of the LocationType object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LocationType

public LocationType()
Constructs an empty LocationType object representing the [Location-Type] Avp.


LocationType

public LocationType(java.util.List<Avp> avps)
             throws AvpTransformationException
Constructs a LocationType object representing the Grouped [Location-Type] Avp.

The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of LocationType, the member will be populated with the Avp value during construction. If an Avp code is unknown, the value will be silently discarded.

Parameters:
avps - a list of Avps that can appear in the Grouped [Location-Type] Avp.
Throws:
AvpTransformationException - if the Avp value is in an unexpected format.
Method Detail

getDeferredLocationEventType

public java.lang.String getDeferredLocationEventType()
Gets the value corresponding to the payload of the [Deferrred-Location-Event-Type] Avp.

Returns:
the value corresponding to the payload of the [Deferrred-Location-Event-Type] Avp.

setDeferredLocationEventType

public void setDeferredLocationEventType(java.lang.String deferredLocationEventType)
Sets the value corresponding to the payload of the [Deferrred-Location-Event-Type] Avp.

Parameters:
submissionTime - the value corresponding to the payload of the [Deferrred-Location-Event-Type] Avp.

getLocationEstimateType

public java.lang.Integer getLocationEstimateType()
Gets the value corresponding to the payload of the [Location-Estimate-Type] Avp.

Returns:
the value corresponding to the payload of the [Location-Estimate-Type] Avp.

setLocationEstimateType

public void setLocationEstimateType(java.lang.Integer locationEstimateType)
Sets the value corresponding to the payload of the [Location-Estimate-Type] Avp.

Parameters:
submissionTime - the value corresponding to the payload of the [Location-Estimate-Type] Avp.

validate

public void validate()
              throws ChargingValidationException
Validates the members of the LocationType object. The charging Web Services call this method before transforming the object into a Grouped Avp. This ensures that improperly formed Avps are not sent to the Diameter peer.

Throws:
ChargingValidationException - if a member of LocationType is in an unexpected format.

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms a LocationType object into a Grouped [Location-Type] Avp.

All non-null members of LocationType will be transformed into Avps nested inside of the [Location-Type] Avp.

Returns:
the [Location-Type] Avp.
Throws:
AvpTransformationException - if a member of LocationType is in an unexpected format.


Copyright © 2006 IBM Corp. All Rights Reserved.