com.ibm.diameter.charging.util
Class InterOperatorIdentifier

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

public class InterOperatorIdentifier
extends java.lang.Object

InterOperatorIdentifier is a lightweight representation of the Grouped [Inter-Operator-Identifier] Avp. It contains the inter-operator identifiers for the originating and terminating network, exchanged via SIP signalling.

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


Constructor Summary
InterOperatorIdentifier()
          Constructs an empty InterOperatorIdentifier object representing the [Inter-Operator-Identifier] Avp.
InterOperatorIdentifier(java.util.List<Avp> avps)
          Constructs an InterOperatorIdentifier object representing the Grouped [Inter-Operator-Identifier] Avp.
 
Method Summary
 java.lang.String getOriginatingIoi()
          Gets the value corresponding to the payload of the [Originating-IOI] Avp.
 java.lang.String getTerminatingIoi()
          Gets the value corresponding to the payload of the [Terminating-IOI] Avp.
 void setOriginatingIoi(java.lang.String originatingIOI)
          Sets the value corresponding to the payload of the [Originating-IOI] Avp.
 void setTerminatingIoi(java.lang.String terminatingIOI)
          Sets the value corresponding to the payload of the [Terminating-IOI] Avp.
 Avp toAvp()
          Transforms an InterOperatorIdentifier object into a Grouped [Inter-Operator-Identifier] Avp.
 void validate()
          Validates the members of the InterOperatorIdentifier object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InterOperatorIdentifier

public InterOperatorIdentifier()
Constructs an empty InterOperatorIdentifier object representing the [Inter-Operator-Identifier] Avp.


InterOperatorIdentifier

public InterOperatorIdentifier(java.util.List<Avp> avps)
                        throws AvpTransformationException
Constructs an InterOperatorIdentifier object representing the Grouped [Inter-Operator-Identifier] Avp.

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

getOriginatingIoi

public java.lang.String getOriginatingIoi()
Gets the value corresponding to the payload of the [Originating-IOI] Avp.

Returns:
the value corresponding to the payload of the [Originating-IOI] Avp.

setOriginatingIoi

public void setOriginatingIoi(java.lang.String originatingIOI)
Sets the value corresponding to the payload of the [Originating-IOI] Avp.

Parameters:
originatingIoi - the value corresponding to the payload of the [Originating-IOI] Avp.

getTerminatingIoi

public java.lang.String getTerminatingIoi()
Gets the value corresponding to the payload of the [Terminating-IOI] Avp.

Returns:
the value corresponding to the payload of the [Terminating-IOI] Avp.

setTerminatingIoi

public void setTerminatingIoi(java.lang.String terminatingIOI)
Sets the value corresponding to the payload of the [Terminating-IOI] Avp.

Parameters:
terminatingIoi - the value corresponding to the payload of the [Terminating-IOI] Avp.

validate

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

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms an InterOperatorIdentifier object into a Grouped [Inter-Operator-Identifier] Avp.

All non-null members of InterOperatorIdentifier will be transformed into Avps nested inside of the [Inter-Operator-Identifier] Avp.

Returns:
the [Inter-Operator-Identifier] Avp.
Throws:
AvpTransformationException - if a member of InterOperatorIdentifier is in an unexpected format.


Copyright © 2006 IBM Corp. All Rights Reserved.