com.ibm.diameter.charging.util
Class ServiceInformation

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

public class ServiceInformation
extends java.lang.Object

ServiceInformation is a lightweight representation of the Grouped [Service-Information] Avp. The 3GPP has separated its vendor-specific AVPs into multiple service-specific charging groups. Contained within ServiceInformation, are nested classes that act as holders for service-specific data

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


Constructor Summary
ServiceInformation()
          Constructs an empty ServiceInformation object representing the [Service-Information] Avp.
ServiceInformation(java.util.List<Avp> avps)
          Constructs a ServiceInformation object representing the Grouped [Service-Information] Avp.
 
Method Summary
 IMSInformation getImsInformation()
          Gets the value corresponding to the payload of the [IMS-Information] Avp.
 LCSInformation getLcsInformation()
          Gets the value corresponding to the payload of the [LCS-Information] Avp.
 MBMSInformation getMbmsInformation()
          Gets the value corresponding to the payload of the [MBMS-Information] Avp.
 MMSInformation getMmsInformation()
          Gets the value corresponding to the payload of the [MMS-Information] Avp.
 PoCInformation getPocInformation()
          Gets the value corresponding to the payload of the [PoC-Information] Avp.
 PSInformation getPsInformation()
          Gets the value corresponding to the payload of the [PS-Information] Avp.
 WLANInformation getWlanInformation()
          Gets the value corresponding to the payload of the [WLAN-Information] Avp.
 void setImsInformation(IMSInformation imsInformation)
          Sets the value corresponding to the payload of the [IMS-Information] Avp.
 void setLcsInformation(LCSInformation lcsInformation)
          Sets the value corresponding to the payload of the [LCS-Information] Avp.
 void setMbmsInformation(MBMSInformation mbmsInformation)
          Sets the value corresponding to the payload of the [MBMS-Information] Avp.
 void setMmsInformation(MMSInformation mmsInformation)
          Sets the value corresponding to the payload of the [MMS-Information] Avp.
 void setPocInformation(PoCInformation pocInformation)
          Sets the value corresponding to the payload of the [PoC-Information] Avp.
 void setPsInformation(PSInformation psInformation)
          Sets the value corresponding to the payload of the [PS-Information] Avp.
 void setWlanInformation(WLANInformation wlanInformation)
          Sets the value corresponding to the payload of the [WLAN-Information] Avp.
 Avp toAvp()
          Transforms a ServiceInformation object into a Grouped [Service-Information] Avp.
 void validate()
          Validates the members of the ServiceInformation object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServiceInformation

public ServiceInformation()
Constructs an empty ServiceInformation object representing the [Service-Information] Avp.


ServiceInformation

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

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

getImsInformation

public IMSInformation getImsInformation()
Gets the value corresponding to the payload of the [IMS-Information] Avp.

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

setImsInformation

public void setImsInformation(IMSInformation imsInformation)
Sets the value corresponding to the payload of the [IMS-Information] Avp.

Parameters:
imsInformation - the value corresponding to the payload of the [IMS-Information] Avp.

getLcsInformation

public LCSInformation getLcsInformation()
Gets the value corresponding to the payload of the [LCS-Information] Avp.

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

setLcsInformation

public void setLcsInformation(LCSInformation lcsInformation)
Sets the value corresponding to the payload of the [LCS-Information] Avp.

Parameters:
lcsInformation - the value corresponding to the payload of the [LCS-Information] Avp.

getMmsInformation

public MMSInformation getMmsInformation()
Gets the value corresponding to the payload of the [MMS-Information] Avp.

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

setMmsInformation

public void setMmsInformation(MMSInformation mmsInformation)
Sets the value corresponding to the payload of the [MMS-Information] Avp.

Parameters:
mmsInformation - the value corresponding to the payload of the [MMS-Information] Avp.

getMbmsInformation

public MBMSInformation getMbmsInformation()
Gets the value corresponding to the payload of the [MBMS-Information] Avp.

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

setMbmsInformation

public void setMbmsInformation(MBMSInformation mbmsInformation)
Sets the value corresponding to the payload of the [MBMS-Information] Avp.

Parameters:
mbmsInformation - the value corresponding to the payload of the [MBMS-Information] Avp.

getPocInformation

public PoCInformation getPocInformation()
Gets the value corresponding to the payload of the [PoC-Information] Avp.

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

setPocInformation

public void setPocInformation(PoCInformation pocInformation)
Sets the value corresponding to the payload of the [PoC-Information] Avp.

Parameters:
pocInformation - the value corresponding to the payload of the [PoC-Information] Avp.

getPsInformation

public PSInformation getPsInformation()
Gets the value corresponding to the payload of the [PS-Information] Avp.

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

setPsInformation

public void setPsInformation(PSInformation psInformation)
Sets the value corresponding to the payload of the [PS-Information] Avp.

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

getWlanInformation

public WLANInformation getWlanInformation()
Gets the value corresponding to the payload of the [WLAN-Information] Avp.

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

setWlanInformation

public void setWlanInformation(WLANInformation wlanInformation)
Sets the value corresponding to the payload of the [WLAN-Information] Avp.

Parameters:
wlanInformation - the value corresponding to the payload of the [WLAN-Information] Avp.

validate

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

toAvp

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

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

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


Copyright © 2006 IBM Corp. All Rights Reserved.