net.java.slee.resource.diameter.ro.events.avp
Interface SdpMediaComponent

All Superinterfaces:
java.lang.Cloneable, net.java.slee.resource.diameter.base.events.avp.DiameterAvp, net.java.slee.resource.diameter.base.events.avp.GroupedAvp
All Known Implementing Classes:
SdpMediaComponentImpl

public interface SdpMediaComponent
extends net.java.slee.resource.diameter.base.events.avp.GroupedAvp

Defines an interface representing the SDP-Media-Component grouped AVP type.

From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V7.1.0) specification:

 
 7.2.95 SDP-Media-Component AVP 
  The SDP-Media-Component AVP (AVP code 843) is of type Grouped and contains information about media used for a IMS
  session. 
  
  It has the following ABNF grammar: 
   SDP-Media-Component ::= AVP Header: 843 
      [ SDP-Media-Name ] 
    * [ SDP-Media-Description ] 
      [ Media-Initiator-Flag] 
      [ Authorized-QoS ] 
      [ TGPP-Charging-Id ]
 

Author:
Alexandre Mendonca , Bartosz Baranowski

Field Summary
 
Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
 
Method Summary
 java.lang.String getAuthorizedQos()
          Returns the value of the Authorized-QoS AVP, of type UTF8String.
 MediaInitiatorFlag getMediaInitiatorFlag()
          Returns the value of the Media-Initiator-Flag AVP, of type Enumerated.
 java.lang.String[] getSdpMediaDescriptions()
          Returns the set of SDP-Media-Description AVPs.
 java.lang.String getSdpMediaName()
          Returns the value of the SDP-Media-Name AVP, of type UTF8String.
 java.lang.String getTgppChargingId()
          Returns the value of the TGPP-Charging-Id AVP, of type OctetString.
 boolean hasAuthorizedQos()
          Returns true if the Authorized-QoS AVP is present in the message.
 boolean hasMediaInitiatorFlag()
          Returns true if the Media-Initiator-Flag AVP is present in the message.
 boolean hasSdpMediaName()
          Returns true if the SDP-Media-Name AVP is present in the message.
 boolean hasTgppChargingId()
          Returns true if the TGPP-Charging-Id AVP is present in the message.
 void setAuthorizedQos(java.lang.String authorizedQos)
          Sets the value of the Authorized-QoS AVP, of type UTF8String.
 void setMediaInitiatorFlag(MediaInitiatorFlag mediaInitiatorFlag)
          Sets the value of the Media-Initiator-Flag AVP, of type Enumerated.
 void setSdpMediaDescription(java.lang.String sdpMediaDescription)
          Sets a single SDP-Media-Description AVP in the message, of type UTF8String.
 void setSdpMediaDescriptions(java.lang.String[] sdpMediaDescriptions)
          Sets the set of SDP-Media-Description AVPs, with all the values in the given array.
 void setSdpMediaName(java.lang.String sdpMediaName)
          Sets the value of the SDP-Media-Name AVP, of type UTF8String.
 void setTgppChargingId(java.lang.String tgppChargingId)
          Sets the value of the TGPP-Charging-Id AVP, of type OctetString.
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp
getExtensionAvps, setExtensionAvps
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, octetStringValue, stringValue
 

Method Detail

getAuthorizedQos

java.lang.String getAuthorizedQos()
Returns the value of the Authorized-QoS AVP, of type UTF8String. A return value of null implies that the AVP has not been set.


getMediaInitiatorFlag

MediaInitiatorFlag getMediaInitiatorFlag()
Returns the value of the Media-Initiator-Flag AVP, of type Enumerated. A return value of null implies that the AVP has not been set.


getSdpMediaDescriptions

java.lang.String[] getSdpMediaDescriptions()
Returns the set of SDP-Media-Description AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no SDP-Media-Description AVPs have been set. The elements in the given array are String objects.


getSdpMediaName

java.lang.String getSdpMediaName()
Returns the value of the SDP-Media-Name AVP, of type UTF8String. A return value of null implies that the AVP has not been set.


getTgppChargingId

java.lang.String getTgppChargingId()
Returns the value of the TGPP-Charging-Id AVP, of type OctetString. A return value of null implies that the AVP has not been set.


hasAuthorizedQos

boolean hasAuthorizedQos()
Returns true if the Authorized-QoS AVP is present in the message.


hasMediaInitiatorFlag

boolean hasMediaInitiatorFlag()
Returns true if the Media-Initiator-Flag AVP is present in the message.


hasSdpMediaName

boolean hasSdpMediaName()
Returns true if the SDP-Media-Name AVP is present in the message.


hasTgppChargingId

boolean hasTgppChargingId()
Returns true if the TGPP-Charging-Id AVP is present in the message.


setAuthorizedQos

void setAuthorizedQos(java.lang.String authorizedQos)
Sets the value of the Authorized-QoS AVP, of type UTF8String.


setMediaInitiatorFlag

void setMediaInitiatorFlag(MediaInitiatorFlag mediaInitiatorFlag)
Sets the value of the Media-Initiator-Flag AVP, of type Enumerated.


setSdpMediaDescription

void setSdpMediaDescription(java.lang.String sdpMediaDescription)
Sets a single SDP-Media-Description AVP in the message, of type UTF8String.


setSdpMediaDescriptions

void setSdpMediaDescriptions(java.lang.String[] sdpMediaDescriptions)
Sets the set of SDP-Media-Description AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getSdpMediaDescriptions() is not guaranteed to return the same array instance, e.g. an "==" check would fail.


setSdpMediaName

void setSdpMediaName(java.lang.String sdpMediaName)
Sets the value of the SDP-Media-Name AVP, of type UTF8String.


setTgppChargingId

void setTgppChargingId(java.lang.String tgppChargingId)
Sets the value of the TGPP-Charging-Id AVP, of type OctetString.



Copyright © 2011. All Rights Reserved.