com.ibm.diameter.charging.util
Class LCSClientName

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

public class LCSClientName
extends java.lang.Object

LCSClientName is a lightweight representation of the Grouped [LCS-Client-Name] Avp. The LCSClientName contains information related to the name of the LCS Client.

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


Constructor Summary
LCSClientName()
          Constructs an empty LCSClientName object representing the [LCS-Client-Name] Avp.
LCSClientName(java.util.List<Avp> avps)
          Constructs a LCSClientName object representing the Grouped [LCS-Client-Name] Avp.
 
Method Summary
 java.lang.String getLcsDataCodingScheme()
          Gets the value corresponding to the payload of the [LCS-Data-Coding-Scheme] Avp.
 java.lang.Integer getLcsFormatIndicator()
          Gets the value corresponding to the payload of the [LCS-Format-Indicator] Avp.
 java.lang.String getLcsNameString()
          Gets the value corresponding to the payload of the [LCS-Name-String] Avp.
 void setLcsDataCodingScheme(java.lang.String lcsDataCodingScheme)
          Sets the value corresponding to the payload of the [LCS-Data-Coding-Scheme] Avp.
 void setLcsFormatIndicator(java.lang.Integer lcsFormatIndicator)
          Sets the value corresponding to the payload of the [LCS-Format-Indicator] Avp.
 void setLcsNameString(java.lang.String lcsNameString)
          Sets the value corresponding to the payload of the [LCS-Name-String] Avp.
 Avp toAvp()
          Transforms a LCSClientName object into a Grouped [LCS-Client-Name] Avp.
 void validate()
          Validates the members of the LCSClientName object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LCSClientName

public LCSClientName()
Constructs an empty LCSClientName object representing the [LCS-Client-Name] Avp.


LCSClientName

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

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

getLcsDataCodingScheme

public java.lang.String getLcsDataCodingScheme()
Gets the value corresponding to the payload of the [LCS-Data-Coding-Scheme] Avp.

Returns:
the value corresponding to the payload of the [LCS-Data-Coding-Scheme] Avp.

setLcsDataCodingScheme

public void setLcsDataCodingScheme(java.lang.String lcsDataCodingScheme)
Sets the value corresponding to the payload of the [LCS-Data-Coding-Scheme] Avp.

Parameters:
lcsDataCodingScheme - the value corresponding to the payload of the [LCS-Data-Coding-Scheme] Avp.

getLcsFormatIndicator

public java.lang.Integer getLcsFormatIndicator()
Gets the value corresponding to the payload of the [LCS-Format-Indicator] Avp.

Returns:
the value corresponding to the payload of the [LCS-Format-Indicator] Avp.

setLcsFormatIndicator

public void setLcsFormatIndicator(java.lang.Integer lcsFormatIndicator)
Sets the value corresponding to the payload of the [LCS-Format-Indicator] Avp.

Parameters:
lcsFormatIndicator - the value corresponding to the payload of the [LCS-Format-Indicator] Avp.

getLcsNameString

public java.lang.String getLcsNameString()
Gets the value corresponding to the payload of the [LCS-Name-String] Avp.

Returns:
the value corresponding to the payload of the [LCS-Name-String] Avp.

setLcsNameString

public void setLcsNameString(java.lang.String lcsNameString)
Sets the value corresponding to the payload of the [LCS-Name-String] Avp.

Parameters:
lcsNameString - the value corresponding to the payload of the [LCS-Name-String] Avp.

validate

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

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms a LCSClientName object into a Grouped [LCS-Client-Name] Avp.

All non-null members of LCSClientName will be transformed into Avps nested inside of the [LCS-Client-Name] Avp.

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


Copyright © 2006 IBM Corp. All Rights Reserved.