com.ibm.diameter.charging.util
Class LCSClientId

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

public class LCSClientId
extends java.lang.Object

LCSClientId is a lightweight representation of the Grouped [LCS-Client-Id] Avp. It contains information related to the identity of an LCS Client.

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


Constructor Summary
LCSClientId()
          Constructs an empty LCSClientId object representing the [LCS-Client-Id] Avp.
LCSClientId(java.util.List<Avp> avps)
          Constructs a LCSClientId object representing the Grouped [LCS-Client-Id] Avp.
 
Method Summary
 java.lang.String getLcsApn()
          Gets the value corresponding to the payload of the [LCS-Apn] Avp.
 java.lang.String getLcsClientDialedByMs()
          Gets the value corresponding to the payload of the [LCS-Client-Dialed-By-MS] Avp.
 java.lang.String getLcsClientExternalId()
          Gets the value corresponding to the payload of the [PS-Information] Avp.
 LCSClientName getLcsClientName()
          Gets the value corresponding to the payload of the [LCS-Client-External-Id] Avp.
 java.lang.Integer getLcsClientType()
          Gets the value corresponding to the payload of the [LCS-Client-Type] Avp.
 LCSRequestorId getLcsRequestorId()
          Gets the value corresponding to the payload of the [LCS-Requestor-Id] Avp.
 void setLcsApn(java.lang.String lcsApn)
          Sets the value corresponding to the payload of the [LCS-Apn] Avp.
 void setLcsClientDialedByMs(java.lang.String lcsClientDialedByMs)
          Sets the value corresponding to the payload of the [LCS-Client-Dialed-By-MS] Avp.
 void setLcsClientExternalId(java.lang.String lcsClientExternalId)
          Sets the value corresponding to the payload of the [LCS-Client-External-Id] Avp.
 void setLcsClientName(LCSClientName lcsClientName)
          Sets the value corresponding to the payload of the [LCS-Client-Name] Avp.
 void setLcsClientType(java.lang.Integer lcsClientType)
          Sets the value corresponding to the payload of the [LCS-Client-Type] Avp.
 void setLcsRequestorId(LCSRequestorId lcsRequestorId)
          Sets the value corresponding to the payload of the [LCS-Requestor-Id] Avp.
 Avp toAvp()
          Transforms a LCSClientId object into a Grouped [LCS-Client-Id] Avp.
 void validate()
          Validates the members of the LCSClientId object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LCSClientId

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


LCSClientId

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

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

getLcsApn

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

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

setLcsApn

public void setLcsApn(java.lang.String lcsApn)
Sets the value corresponding to the payload of the [LCS-Apn] Avp.

Parameters:
lcsApn - the value corresponding to the payload of the [LCS-Apn] Avp.

getLcsClientDialedByMs

public java.lang.String getLcsClientDialedByMs()
Gets the value corresponding to the payload of the [LCS-Client-Dialed-By-MS] Avp.

Returns:
the value corresponding to the payload of the [LCS-Client-Dialed-By-MS] Avp.

setLcsClientDialedByMs

public void setLcsClientDialedByMs(java.lang.String lcsClientDialedByMs)
Sets the value corresponding to the payload of the [LCS-Client-Dialed-By-MS] Avp.

Parameters:
lcsClientDialedByMs - the value corresponding to the payload of the [LCS-Client-Dialed-By-MS] Avp.

getLcsClientExternalId

public java.lang.String getLcsClientExternalId()
Gets the value corresponding to the payload of the [PS-Information] Avp.

Returns:
the value corresponding to the payload of the [PS-Information] Avp.

setLcsClientExternalId

public void setLcsClientExternalId(java.lang.String lcsClientExternalId)
Sets the value corresponding to the payload of the [LCS-Client-External-Id] Avp.

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

getLcsClientName

public LCSClientName getLcsClientName()
Gets the value corresponding to the payload of the [LCS-Client-External-Id] Avp.

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

setLcsClientName

public void setLcsClientName(LCSClientName lcsClientName)
Sets the value corresponding to the payload of the [LCS-Client-Name] Avp.

Parameters:
lcsClientName - the value corresponding to the payload of the [LCS-Client-Name] Avp.

getLcsClientType

public java.lang.Integer getLcsClientType()
Gets the value corresponding to the payload of the [LCS-Client-Type] Avp.

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

setLcsClientType

public void setLcsClientType(java.lang.Integer lcsClientType)
Sets the value corresponding to the payload of the [LCS-Client-Type] Avp.

Parameters:
lcsClientType - the value corresponding to the payload of the [LCS-Client-Type] Avp.

getLcsRequestorId

public LCSRequestorId getLcsRequestorId()
Gets the value corresponding to the payload of the [LCS-Requestor-Id] Avp.

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

setLcsRequestorId

public void setLcsRequestorId(LCSRequestorId lcsRequestorId)
Sets the value corresponding to the payload of the [LCS-Requestor-Id] Avp.

Parameters:
lcsRequestorId - the value corresponding to the payload of the [LCS-Requestor-Id] Avp.

validate

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

toAvp

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

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

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


Copyright © 2006 IBM Corp. All Rights Reserved.