public interface ExperimentalResult extends GroupedAvp
7.6. Experimental-Result AVP The Experimental-Result AVP (AVP Code 297) is of type Grouped, and indicates whether a particular vendor-specific request was completed successfully or whether an error occurred. This AVP has the following structure: AVP Format Experimental-Result ::= < AVP Header: 297 > { Vendor-Id } { Experimental-Result-Code } The Vendor-Id AVP (see Section 5.3.3) in this grouped AVP identifies the vendor responsible for the assignment of the result code that follows. All Diameter answer messages defined in vendor-specific applications MUST include either one Result-Code AVP or one Experimental-Result AVP.Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
long |
getExperimentalResultCode()
Returns the value of the Experimental-Result-Code AVP, of type Unsigned32.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long |
getVendorId()
Returns the value of the Vendor-Id AVP, of type Unsigned32.
|
boolean |
hasExperimentalResultCode()
Returns true if the Experimental-Result-Code AVP is present in the Experimental-Result AVP.
|
boolean |
hasVendorId()
Returns true if the Vendor-Id AVP is present in the Experimental-Result AVP.
|
void |
removeExperimentalResultCode()
Removes the Experimental-Result-Code AVP from the Experimental-Result AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Experimental-Result AVP.
|
void |
removeVendorId()
Removes the Vendor-Id AVP from the Experimental-Result AVP.
|
void |
setExperimentalResultCode(long experimentalResultCode)
Sets the value of the Experimental-Result-Code AVP, of type Unsigned32.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setVendorId(long vendorId)
Sets the value of the Vendor-Id AVP, of type Unsigned32.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasVendorId()
long getVendorId()
hasVendorId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Vendor-Id AVP has not been set.void setVendorId(long vendorId)
void removeVendorId()
boolean hasExperimentalResultCode()
long getExperimentalResultCode()
hasExperimentalResultCode()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Experimental-Result-Code AVP has not been set.void setExperimentalResultCode(long experimentalResultCode)
void removeExperimentalResultCode()
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()