com.ibm.diameter.charging.util
Class LCSRequestorId

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

public class LCSRequestorId
extends java.lang.Object

LCSRequestorId is a lightweight representation of the Grouped [LCS-Requestor-Id] Avp. It contains the identification of the LCS requestor.

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


Constructor Summary
LCSRequestorId()
          Constructs an empty LCSRequestorId object representing the [LCS-Requestor-Id] Avp.
LCSRequestorId(java.util.List<Avp> avps)
          Constructs a LCSRequestorId object representing the Grouped [LCS-Requestor-Id] Avp.
 
Method Summary
 java.lang.String getLcsDataCodingScheme()
          Gets the value corresponding to the payload of the [LCS-Data-Coding-Scheme] Avp.
 java.lang.String getLcsRequestorIdString()
          // * Gets the value corresponding to the payload of the [LCS-Requestor-Id-String] Avp.
 void setLcsDataCodingScheme(java.lang.String lcsDataCodingScheme)
          Sets the value corresponding to the payload of the [LCS-Data-Coding-Scheme] Avp.
 void setLcsRequestorIdString(java.lang.String lcsRequestorIdString)
          Sets the value corresponding to the payload of the [LCS-Requestor-Id-String] Avp.
 Avp toAvp()
          Transforms a LCSRequestorId object into a Grouped [LCS-Requestor-Id] Avp.
 void validate()
          Validates the members of the LCSRequestorId object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LCSRequestorId

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


LCSRequestorId

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

The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of LCSRequestorId, 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-Requestor-Id] 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.

getLcsRequestorIdString

public java.lang.String getLcsRequestorIdString()
// * Gets the value corresponding to the payload of the [LCS-Requestor-Id-String] Avp.

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

setLcsRequestorIdString

public void setLcsRequestorIdString(java.lang.String lcsRequestorIdString)
Sets the value corresponding to the payload of the [LCS-Requestor-Id-String] Avp.

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

validate

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

toAvp

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

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

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


Copyright © 2006 IBM Corp. All Rights Reserved.