net.java.slee.resource.diameter.base.events.avp
Interface ExperimentalResultAvp

All Superinterfaces:

java.lang.Cloneable, DiameterAvp, GroupedAvp

All Known Implementing Classes:

ExperimentalResultAvpImpl

public interface ExperimentalResultAvp
extends GroupedAvp

Defines an interface representing the Experimental-Result grouped AVP type. From the Diameter Base Protocol (rfc3588.txt) specification:

 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.  Its Data field has the
    following ABNF grammar:
 
    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 which
    follows.  All Diameter answer messages defined in vendor-specific
    applications MUST include either one Result-Code AVP or one
    Experimental-Result AVP.
 
 

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

long	getExperimentalResultCode() Returns the value of the Experimental-Result-Code AVP, of type Unsigned32.
boolean	hasExperimentalResultCode() Returns true if the Experimental-Result-Code AVP is present in the message.
boolean	hasVendorId() Returns true if the Vendor-Id AVP is present in the message.
void	setExperimentalResultCode(long experimentalResultCode) Sets the value of the Experimental-Result-Code AVP, of type Unsigned32.
void	setVendorId(long vendorId) Sets the value of the Vendor-Id AVP, of type Unsigned32.

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp

getExtensionAvps, hasExtensionAvps, 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, stringValue

Method Detail

hasVendorId

boolean hasVendorId()

Returns true if the Vendor-Id AVP is present in the message.

setVendorId

void setVendorId(long vendorId)

Sets the value of the Vendor-Id AVP, of type Unsigned32.

Throws:

java.lang.IllegalStateException - if setVendorId has already been called

hasExperimentalResultCode

boolean hasExperimentalResultCode()

Returns true if the Experimental-Result-Code AVP is present in the message.

getExperimentalResultCode

long getExperimentalResultCode()

Returns the value of the Experimental-Result-Code AVP, of type Unsigned32. A return value of -1 implies that the AVP has not been set or some error has been encountered.

setExperimentalResultCode

void setExperimentalResultCode(long experimentalResultCode)

Sets the value of the Experimental-Result-Code AVP, of type Unsigned32.

Throws:

java.lang.IllegalStateException - if setExperimentalResultCode has already been called