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

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:
MbmsInformationImpl

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

Defines an interface representing the MBMS-Information grouped AVP type.

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

 7.2.55 MBMS-Information AVP 
 The MBMS-Information AVP (AVP code 880) is of type Grouped. Its purpose is to allow the transmission of additional MBMS service specific information elements. 
 
 It has the following ABNF grammar: 
  MBMS-Information ::= AVP Header: 880 
       { TMGI } 
       { MBMS-Service-Type } 
       { MBMS-User-Service-Type } 
       [ File-Repair-Supported ] 
       [ Required-MBMS-Bearer-Capabilities ] 
       [ MBMS-2G-3G-Indicator ] 
       [ RAI ] 
     * [ MBMS-Service-Area ] 
       [ MBMS-Session-Identity ]
 

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
 FileRepairSupported getFileRepairSupported()
          Returns the value of the File-Repair-Supported AVP, of type Enumerated.
 Mbms2g3gIndicator getMbms2g3gIndicator()
          Returns the value of the MBMS-2G-3G-Indicator AVP, of type OctetString.
 java.lang.String[] getMbmsServiceAreas()
          Returns the set of MBMS-Service-Area AVPs.
 MbmsServiceType getMbmsServiceType()
          Returns the value of the MBMS-Service-Type AVP, of type Enumerated.
 java.lang.String getMbmsSessionIdentity()
          Returns the value of the MBMS-Session-Identity AVP, of type OctetString.
 MbmsUserServiceType getMbmsUserServiceType()
          Returns the value of the MBMS-User-Service-Type AVP, of type Enumerated.
 java.lang.String getRai()
          Returns the value of the RAI AVP, of type OctetString.
 java.lang.String getRequiredMbmsBearerCapabilities()
          Returns the value of the Required-MBMS-Bearer-Capabilities AVP, of type OctetString.
 java.lang.String getTmgi()
          Returns the value of the TMGI AVP, of type OctetString.
 boolean hasFileRepairSupported()
          Returns true if the File-Repair-Supported AVP is present in the message.
 boolean hasMbms2g3gIndicator()
          Returns true if the MBMS-2G-3G-Indicator AVP is present in the message.
 boolean hasMbmsServiceType()
          Returns true if the MBMS-Service-Type AVP is present in the message.
 boolean hasMbmsSessionIdentity()
          Returns true if the MBMS-Session-Identity AVP is present in the message.
 boolean hasMbmsUserServiceType()
          Returns true if the MBMS-User-Service-Type AVP is present in the message.
 boolean hasRai()
          Returns true if the RAI AVP is present in the message.
 boolean hasRequiredMbmsBearerCapabilities()
          Returns true if the Required-MBMS-Bearer-Capabilities AVP is present in the message.
 boolean hasTmgi()
          Returns true if the TMGI AVP is present in the message.
 void setFileRepairSupported(FileRepairSupported fileRepairSupported)
          Sets the value of the File-Repair-Supported AVP, of type Enumerated.
 void setMbms2g3gIndicator(Mbms2g3gIndicator mbms2g3gIndicator)
          Sets the value of the MBMS-2G-3G-Indicator AVP, of type OctetString.
 void setMbmsServiceArea(java.lang.String mbmsServiceArea)
          Sets a single MBMS-Service-Area AVP in the message, of type OctetString.
 void setMbmsServiceAreas(java.lang.String[] mbmsServiceAreas)
          Sets the set of MBMS-Service-Area AVPs, with all the values in the given array.
 void setMbmsServiceType(MbmsServiceType mbmsServiceType)
          Sets the value of the MBMS-Service-Type AVP, of type Enumerated.
 void setMbmsSessionIdentity(java.lang.String mbmsSessionIdentity)
          Sets the value of the MBMS-Session-Identity AVP, of type OctetString.
 void setMbmsUserServiceType(MbmsUserServiceType mbmsUserServiceType)
          Sets the value of the MBMS-User-Service-Type AVP, of type Enumerated.
 void setRai(java.lang.String rai)
          Sets the value of the RAI AVP, of type OctetString.
 void setRequiredMbmsBearerCapabilities(java.lang.String requiredMbmsBearerCapabilities)
          Sets the value of the Required-MBMS-Bearer-Capabilities AVP, of type OctetString.
 void setTmgi(java.lang.String tmgi)
          Sets the value of the TMGI 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

getFileRepairSupported

FileRepairSupported getFileRepairSupported()
Returns the value of the File-Repair-Supported AVP, of type Enumerated. A return value of null implies that the AVP has not been set.


getMbms2g3gIndicator

Mbms2g3gIndicator getMbms2g3gIndicator()
Returns the value of the MBMS-2G-3G-Indicator AVP, of type OctetString. A return value of null implies that the AVP has not been set.


getMbmsServiceAreas

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


getMbmsServiceType

MbmsServiceType getMbmsServiceType()
Returns the value of the MBMS-Service-Type AVP, of type Enumerated. A return value of null implies that the AVP has not been set.


getMbmsSessionIdentity

java.lang.String getMbmsSessionIdentity()
Returns the value of the MBMS-Session-Identity AVP, of type OctetString. A return value of null implies that the AVP has not been set.


getMbmsUserServiceType

MbmsUserServiceType getMbmsUserServiceType()
Returns the value of the MBMS-User-Service-Type AVP, of type Enumerated. A return value of null implies that the AVP has not been set.


getRai

java.lang.String getRai()
Returns the value of the RAI AVP, of type OctetString. A return value of null implies that the AVP has not been set.


getRequiredMbmsBearerCapabilities

java.lang.String getRequiredMbmsBearerCapabilities()
Returns the value of the Required-MBMS-Bearer-Capabilities AVP, of type OctetString. A return value of null implies that the AVP has not been set.


getTmgi

java.lang.String getTmgi()
Returns the value of the TMGI AVP, of type OctetString. A return value of null implies that the AVP has not been set.


hasFileRepairSupported

boolean hasFileRepairSupported()
Returns true if the File-Repair-Supported AVP is present in the message.


hasMbms2g3gIndicator

boolean hasMbms2g3gIndicator()
Returns true if the MBMS-2G-3G-Indicator AVP is present in the message.


hasMbmsServiceType

boolean hasMbmsServiceType()
Returns true if the MBMS-Service-Type AVP is present in the message.


hasMbmsSessionIdentity

boolean hasMbmsSessionIdentity()
Returns true if the MBMS-Session-Identity AVP is present in the message.


hasMbmsUserServiceType

boolean hasMbmsUserServiceType()
Returns true if the MBMS-User-Service-Type AVP is present in the message.


hasRai

boolean hasRai()
Returns true if the RAI AVP is present in the message.


hasRequiredMbmsBearerCapabilities

boolean hasRequiredMbmsBearerCapabilities()
Returns true if the Required-MBMS-Bearer-Capabilities AVP is present in the message.


hasTmgi

boolean hasTmgi()
Returns true if the TMGI AVP is present in the message.


setFileRepairSupported

void setFileRepairSupported(FileRepairSupported fileRepairSupported)
Sets the value of the File-Repair-Supported AVP, of type Enumerated.


setMbms2g3gIndicator

void setMbms2g3gIndicator(Mbms2g3gIndicator mbms2g3gIndicator)
Sets the value of the MBMS-2G-3G-Indicator AVP, of type OctetString.


setMbmsServiceArea

void setMbmsServiceArea(java.lang.String mbmsServiceArea)
Sets a single MBMS-Service-Area AVP in the message, of type OctetString.


setMbmsServiceAreas

void setMbmsServiceAreas(java.lang.String[] mbmsServiceAreas)
Sets the set of MBMS-Service-Area 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 getMbmsServiceAreas() is not guaranteed to return the same array instance, e.g. an "==" check would fail.


setMbmsServiceType

void setMbmsServiceType(MbmsServiceType mbmsServiceType)
Sets the value of the MBMS-Service-Type AVP, of type Enumerated.


setMbmsSessionIdentity

void setMbmsSessionIdentity(java.lang.String mbmsSessionIdentity)
Sets the value of the MBMS-Session-Identity AVP, of type OctetString.


setMbmsUserServiceType

void setMbmsUserServiceType(MbmsUserServiceType mbmsUserServiceType)
Sets the value of the MBMS-User-Service-Type AVP, of type Enumerated.


setRai

void setRai(java.lang.String rai)
Sets the value of the RAI AVP, of type OctetString.


setRequiredMbmsBearerCapabilities

void setRequiredMbmsBearerCapabilities(java.lang.String requiredMbmsBearerCapabilities)
Sets the value of the Required-MBMS-Bearer-Capabilities AVP, of type OctetString.


setTmgi

void setTmgi(java.lang.String tmgi)
Sets the value of the TMGI AVP, of type OctetString.



Copyright © 2011. All Rights Reserved.