com.ibm.diameter.charging.util
Class PoCInformation

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

public class PoCInformation
extends java.lang.Object

PoCInformation is a lightweight representation of the Grouped [PoC-Information] Avp. It is used to record accounting and charging information that is specific to the Push-To-Talk over Cellular (PoC) service.

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


Constructor Summary
PoCInformation()
          Constructs an empty PoCInformation object representing the [PoC-Information] Avp.
PoCInformation(java.util.List<Avp> avps)
          Constructs a PoCInformation object representing the Grouped [PoC-Information] Avp.
 
Method Summary
 java.lang.String getChargedParty()
          Gets the value corresponding to the payload of the [Charged-Party] Avp.
 java.lang.Integer getNumberOfParticipants()
          Gets the value corresponding to the payload of the [Number-Of-Participants] Avp.
 java.lang.String[] getParticipantsInvolved()
          Gets the value corresponding to the payload of the [Participants-Involved] Avp.
 java.lang.String getPocControllingAddress()
          Gets the value corresponding to the payload of the [PoC-Controlling-Address] Avp.
 java.lang.String getPocGroupName()
          Gets the value corresponding to the payload of the [PoC-Group-Name] Avp.
 java.lang.Integer getPocServerRole()
          Gets the value corresponding to the payload of the [PoC-Server-Role] Avp.
 java.lang.String getPocSessionId()
          Gets the value corresponding to the payload of the [PoC-Session-Id] Avp.
 java.lang.Integer getPocSessionType()
          Gets the value corresponding to the payload of the [PoC-Session-Type] Avp.
 TalkBurstExchange[] getTalkBurstExchange()
          Gets the values corresponding to the payloads of the [Talk-Burst-Exchange] Avps.
 void setChargedParty(java.lang.String chargedParty)
          Sets the value corresponding to the payload of the [Charged-Party] Avp.
 void setNumberOfParticipants(java.lang.Integer numberOfParticipants)
          Sets the value corresponding to the payload of the [Number-Of-Participants] Avp.
 void setParticipantsInvolved(java.lang.String[] participantsInvolved)
          Sets the values corresponding to the payloads of the [Participants-Involved] Avps.
 void setPocControllingAddress(java.lang.String pocControllingAddress)
          Sets the value corresponding to the payload of the [PoC-Controlling-Address] Avp.
 void setPocGroupName(java.lang.String pocGroupName)
          Sets the value corresponding to the payload of the [PoC-Group-Name] Avp.
 void setPocServerRole(java.lang.Integer pocServerRole)
          Sets the value corresponding to the payload of the [PoC-Server-Role] Avp.
 void setPocSessionId(java.lang.String pocSessionId)
          Sets the value corresponding to the payload of the [PoC-Session-Id] Avp.
 void setPocSessionType(java.lang.Integer pocSessionType)
          Sets the value corresponding to the payload of the [PoC-Session-Type] Avp.
 void setTalkBurstExchange(TalkBurstExchange[] talkBurstExchange)
          Sets the values corresponding to the payloads of the [Talk-Burst-Exchange] Avps.
 Avp toAvp()
          Transforms a PoCInformation object into a Grouped [PoC-Information] Avp.
 void validate()
          Validates the members of the PoCInformation object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PoCInformation

public PoCInformation()
Constructs an empty PoCInformation object representing the [PoC-Information] Avp.


PoCInformation

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

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

getChargedParty

public java.lang.String getChargedParty()
Gets the value corresponding to the payload of the [Charged-Party] Avp.

Returns:
the value corresponding to the payload of the [Adaptations] Avp.

setChargedParty

public void setChargedParty(java.lang.String chargedParty)
Sets the value corresponding to the payload of the [Charged-Party] Avp.

Parameters:
chargedParty - the value corresponding to the payload of the [Charged-Party] Avp.

getNumberOfParticipants

public java.lang.Integer getNumberOfParticipants()
Gets the value corresponding to the payload of the [Number-Of-Participants] Avp.

Returns:
the value corresponding to the payload of the [Number-Of-Participants] Avp.

setNumberOfParticipants

public void setNumberOfParticipants(java.lang.Integer numberOfParticipants)
Sets the value corresponding to the payload of the [Number-Of-Participants] Avp.

Parameters:
numberOfParticipants - the value corresponding to the payload of the [Number-Of-Participants] Avp.

getParticipantsInvolved

public java.lang.String[] getParticipantsInvolved()
Gets the value corresponding to the payload of the [Participants-Involved] Avp.

Returns:
the value corresponding to the payload of the [Participants-Involved] Avp.

setParticipantsInvolved

public void setParticipantsInvolved(java.lang.String[] participantsInvolved)
Sets the values corresponding to the payloads of the [Participants-Involved] Avps.

Parameters:
participantsInvolved - the values corresponding to the payloads of the [Participants-Involved] Avps.

getPocControllingAddress

public java.lang.String getPocControllingAddress()
Gets the value corresponding to the payload of the [PoC-Controlling-Address] Avp.

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

setPocControllingAddress

public void setPocControllingAddress(java.lang.String pocControllingAddress)
Sets the value corresponding to the payload of the [PoC-Controlling-Address] Avp.

Parameters:
pocControllingAddress - the value corresponding to the payload of the [PoC-Controlling-Address] Avp.

getPocGroupName

public java.lang.String getPocGroupName()
Gets the value corresponding to the payload of the [PoC-Group-Name] Avp.

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

setPocGroupName

public void setPocGroupName(java.lang.String pocGroupName)
Sets the value corresponding to the payload of the [PoC-Group-Name] Avp.

Parameters:
pocGroupName - the value corresponding to the payload of the [PoC-Group-Name] Avp.

getPocServerRole

public java.lang.Integer getPocServerRole()
Gets the value corresponding to the payload of the [PoC-Server-Role] Avp.

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

setPocServerRole

public void setPocServerRole(java.lang.Integer pocServerRole)
Sets the value corresponding to the payload of the [PoC-Server-Role] Avp.

Parameters:
pocServerRole - the value corresponding to the payload of the [PoC-Server-Role] Avp.

getPocSessionId

public java.lang.String getPocSessionId()
Gets the value corresponding to the payload of the [PoC-Session-Id] Avp.

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

setPocSessionId

public void setPocSessionId(java.lang.String pocSessionId)
Sets the value corresponding to the payload of the [PoC-Session-Id] Avp.

Parameters:
pocSessionId - the value corresponding to the payload of the [PoC-Session-Id] Avp.

getPocSessionType

public java.lang.Integer getPocSessionType()
Gets the value corresponding to the payload of the [PoC-Session-Type] Avp.

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

setPocSessionType

public void setPocSessionType(java.lang.Integer pocSessionType)
Sets the value corresponding to the payload of the [PoC-Session-Type] Avp.

Parameters:
pocSessionType - the value corresponding to the payload of the [PoC-Session-Type] Avp.

getTalkBurstExchange

public TalkBurstExchange[] getTalkBurstExchange()
Gets the values corresponding to the payloads of the [Talk-Burst-Exchange] Avps.

Returns:
the values corresponding to the payloads of the [Talk-Burst-Exchange] Avps.

setTalkBurstExchange

public void setTalkBurstExchange(TalkBurstExchange[] talkBurstExchange)
Sets the values corresponding to the payloads of the [Talk-Burst-Exchange] Avps.

Parameters:
talkBurstExchange - the values corresponding to the payloads of the [Talk-Burst-Exchange] Avps.

validate

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

toAvp

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

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

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


Copyright © 2006 IBM Corp. All Rights Reserved.