public interface UserCsgInformation extends GroupedAvp
7.2.240 A User-CSG-Information AVP The User-CSG-Information AVP (AVP code 2319) is of type Grouped and holds the user “Closed Subscriber Group” Information associated to CSG cell access: it comprises CSG ID within the PLMN, Access mode and indication on CSG membership for the user when hybrid access applies, as defined in TS 29.060 [225] for GPRS case, and in TS 29.274 [226] for EPC case. It has the following ABNF grammar: User-CSG-Information ::= < AVP Header: 2319> { CSG-Id } { CSG-Access-Mode } [ CSG-Membership-Indication ]Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
CsgAccessMode |
getCsgAccessMode()
Returns the value of the CSG-Access-Mode AVP, of type Enumerated.
|
long |
getCsgId()
Returns the value of the CSG-Id AVP, of type Unsigned32.
|
CsgMembershipIndication |
getCsgMembershipIndication()
Returns the value of the CSG-Membership-Indication AVP, of type Enumerated.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
boolean |
hasCsgAccessMode()
Returns true if the CSG-Access-Mode AVP is present in the User-CSG-Information AVP.
|
boolean |
hasCsgId()
Returns true if the CSG-Id AVP is present in the User-CSG-Information AVP.
|
boolean |
hasCsgMembershipIndication()
Returns true if the CSG-Membership-Indication AVP is present in the User-CSG-Information AVP.
|
void |
removeCsgAccessMode()
Removes the CSG-Access-Mode AVP from the User-CSG-Information AVP.
|
void |
removeCsgId()
Removes the CSG-Id AVP from the User-CSG-Information AVP.
|
void |
removeCsgMembershipIndication()
Removes the CSG-Membership-Indication AVP from the User-CSG-Information AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the User-CSG-Information AVP.
|
void |
setCsgAccessMode(CsgAccessMode csgAccessMode)
Sets the value of the CSG-Access-Mode AVP, of type Enumerated.
|
void |
setCsgId(long csgId)
Sets the value of the CSG-Id AVP, of type Unsigned32.
|
void |
setCsgMembershipIndication(CsgMembershipIndication csgMembershipIndication)
Sets the value of the CSG-Membership-Indication AVP, of type Enumerated.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasCsgId()
long getCsgId()
hasCsgId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the CSG-Id AVP has not been set.void setCsgId(long csgId)
void removeCsgId()
boolean hasCsgAccessMode()
CsgAccessMode getCsgAccessMode()
void setCsgAccessMode(CsgAccessMode csgAccessMode)
java.lang.NullPointerException
- if csgAccessMode
is null
.void removeCsgAccessMode()
boolean hasCsgMembershipIndication()
CsgMembershipIndication getCsgMembershipIndication()
void setCsgMembershipIndication(CsgMembershipIndication csgMembershipIndication)
java.lang.NullPointerException
- if csgMembershipIndication
is null
.void removeCsgMembershipIndication()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
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)java.lang.NullPointerException
- if avps
is null
.void removeExtensionAvps()