Package org.jainslee.resources.diameter.gx.types.va10

Interface AreaScope

All Superinterfaces:

Cloneable, DiameterAvp, GroupedAvp

public interface AreaScope
extends GroupedAvp

Defines an interface representing the Area-Scope grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification:

 7.3.138 Area-Scope
 
     The Area-Scope AVP is of type Grouped. See 3GPP TS 32.422 [23].
 
     Important: In 3GPP TS 29.272 V10.3.0 (2011-06) all the excluded AVPs codes are undefined.
 
     The AVP format shall conform to:
             Area-Scope ::= <AVP Header: 1624 10415>
                             *[ Cell-Global-Identity ] #exclude
                             *[ E-UTRAN-Cell-Global-Identity ] #exclude
                             *[ Routing-Area-Identity ] #exclude
                             *[ Location-Area-Identity ] #exclude
                             *[ Tracking-Area-Identity ] #exclude
                             *[ AVP ]
 

Field Summary

Fields inherited from interface org.jainslee.resources.diameter.base.DiameterAvp

FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT

Method Summary

Modifier and Type	Method	Description
DiameterAvp[]	getExtensionAvps()	Returns the set of extension AVPs.
void	removeExtensionAvps()	Removes all extension AVPs from the Area-Scope AVP.
void	setExtensionAvps(DiameterAvp[] avps)	Sets the set of extension AVPs with all the values in the given array.

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterAvp

byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue

Method Detail

getExtensionAvps

DiameterAvp[] getExtensionAvps()

Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the Area-Scope AVP. A return value of null implies that no extensions AVPs have been set.

setExtensionAvps

void setExtensionAvps(DiameterAvp[] avps)
               throws AvpNotAllowedException

Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to Area-Scope AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

AvpNotAllowedException - if an AVP is encountered of a type already known to this class (i.e. an AVP for which get/set methods already appear in this class)

NullPointerException - if avps is null.

removeExtensionAvps

void removeExtensionAvps()

Removes all extension AVPs from the Area-Scope AVP. If no extension AVPs are present, this method returns silently.