com.ibm.diameter.charging.util
Class LCSInformation

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

public class LCSInformation
extends java.lang.Object

LCSInformation is a lightweight representation of the Grouped [LCS-Information] Avp. It is used to record accounting and charging information that is specific to a Location Service (LCS).

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


Constructor Summary
LCSInformation()
          Constructs an empty LCSInformation object representing the [LCS-Information] Avp.
LCSInformation(java.util.List<Avp> avps)
          Constructs a LCSInformation object representing the Grouped [LCS-Information] Avp.
 
Method Summary
 java.lang.String getImsi()
          Gets the value corresponding to the payload of the [IMSI] Avp.
 LCSClientId getLcsClientId()
          Gets the value corresponding to the payload of the [LCS-Client-Id] Avp.
 java.lang.String getLocationEstimate()
          Gets the value corresponding to the payload of the [Location-Estimate] Avp.
 LocationType getLocationType()
          Gets the value corresponding to the payload of the [Location-Type] Avp.
 byte[] getMsisdn()
          Gets the value corresponding to the payload of the [MSISDN] Avp.
 java.lang.String getPositioningData()
          Gets the value corresponding to the payload of the [Positioning-Data] Avp.
 void setImsi(java.lang.String imsi)
          Sets the value corresponding to the payload of the [IMSI] Avp.
 void setLcsClientId(LCSClientId lcsClientId)
          Sets the value corresponding to the payload of the [LCS-Client-Id] Avp.
 void setLocationEstimate(java.lang.String locationEstimate)
          Sets the value corresponding to the payload of the [Location-Estimate] Avp.
 void setLocationType(LocationType locationType)
          Sets the value corresponding to the payload of the [Location-Type] Avp.
 void setMsisdn(byte[] msisdn)
          Sets the value corresponding to the payload of the [MSISDN] Avp.
 void setPositioningData(java.lang.String positioningData)
          Sets the value corresponding to the payload of the [Positioning-Data] Avp.
 Avp toAvp()
          Transforms a LCSInformation object into a Grouped [LCS-Information] Avp.
 void validate()
          Validates the members of the LCSInformation object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LCSInformation

public LCSInformation()
Constructs an empty LCSInformation object representing the [LCS-Information] Avp.


LCSInformation

public LCSInformation(java.util.List<Avp> avps)
               throws AvpTransformationException
Constructs a LCSInformation object representing the Grouped [LCS-Information] Avp.

The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of LCSInformation, 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 [LCS-Information] Avp.
Throws:
AvpTransformationException - if the Avp value is in an unexpected format.
Method Detail

getLcsClientId

public LCSClientId getLcsClientId()
Gets the value corresponding to the payload of the [LCS-Client-Id] Avp.

Returns:
the value corresponding to the payload of the [LCS-Client-Id] Avp.

setLcsClientId

public void setLcsClientId(LCSClientId lcsClientId)
Sets the value corresponding to the payload of the [LCS-Client-Id] Avp.

Parameters:
lcsClientId - the value corresponding to the payload of the [LCS-Client-Id] Avp.

getLocationEstimate

public java.lang.String getLocationEstimate()
Gets the value corresponding to the payload of the [Location-Estimate] Avp.

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

setLocationEstimate

public void setLocationEstimate(java.lang.String locationEstimate)
Sets the value corresponding to the payload of the [Location-Estimate] Avp.

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

getLocationType

public LocationType getLocationType()
Gets the value corresponding to the payload of the [Location-Type] Avp.

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

setLocationType

public void setLocationType(LocationType locationType)
Sets the value corresponding to the payload of the [Location-Type] Avp.

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

getPositioningData

public java.lang.String getPositioningData()
Gets the value corresponding to the payload of the [Positioning-Data] Avp.

Returns:
the value corresponding to the payload of the [Positioning-Data] Avp.

setPositioningData

public void setPositioningData(java.lang.String positioningData)
Sets the value corresponding to the payload of the [Positioning-Data] Avp.

Parameters:
positioningData - the value corresponding to the payload of the [Positioning-Data] Avp.

getImsi

public java.lang.String getImsi()
Gets the value corresponding to the payload of the [IMSI] Avp.

Returns:
the value corresponding to the payload of the [IMSI] Avp.

setImsi

public void setImsi(java.lang.String imsi)
Sets the value corresponding to the payload of the [IMSI] Avp.

Parameters:
imsi - the value corresponding to the payload of the [IMSI] Avp.

getMsisdn

public byte[] getMsisdn()
Gets the value corresponding to the payload of the [MSISDN] Avp.

Returns:
the value corresponding to the payload of the [MSISDN] Avp.

setMsisdn

public void setMsisdn(byte[] msisdn)
Sets the value corresponding to the payload of the [MSISDN] Avp.

Parameters:
msisdn - the value corresponding to the payload of the [MSISDN] Avp.

validate

public void validate()
              throws ChargingValidationException
Validates the members of the LCSInformation 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 LCSInformation is in an unexpected format.

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms a LCSInformation object into a Grouped [LCS-Information] Avp.

All non-null members of LCSInformation will be transformed into Avps nested inside of the [LCS-Information] Avp.

Returns:
the [LCS-Information] Avp.
Throws:
AvpTransformationException - if a member of LCSInformation is in an unexpected format.


Copyright © 2006 IBM Corp. All Rights Reserved.