net.java.slee.resource.diameter.ro.events
Interface RoCreditControlAnswer

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.DiameterMessage, RoCreditControlMessage

All Known Implementing Classes:

RoCreditControlAnswerImpl

public interface RoCreditControlAnswer
extends RoCreditControlMessage

Interface defining RoCreditControlAnswer message. It has following structure:

         ::= < Diameter Header: 272, PXY >
                  < Session-Id > 
                  { Result-Code } 
                  { Origin-Host } 
                  { Origin-Realm } 
                  { Auth-Application-Id } 
                  { CC-Request-Type } 
                  { CC-Request-Number } 
                  [ CC-Session-Failover ]  
            *[ Multiple-Services-Credit-Control ]  
                  [ Cost-Information]  
                  [ Credit-Control-Failure-Handling ]  
                 *[ Redirect-Host] 
                  [ Redirect-Host-Usage ] 
                  [ Redirect-Max-Cache-Time ] 
                 *[ Proxy-Info ] 
                 *[ Route-Record ] 
                 *[ Failed-AVP ]
                  [ Service-Information ]
                 *[ AVP ]
 

Author:

Bartosz Baranowski , Alexandre Mendonca

Method Summary

net.java.slee.resource.diameter.cca.events.avp.CcSessionFailoverType	getCcSessionFailover() Returns the value of the CC-Session-Failover AVP, of type Enumerated.
net.java.slee.resource.diameter.cca.events.avp.CostInformationAvp	getCostInformation() Returns the value of the Cost-Information AVP, of type Grouped.
net.java.slee.resource.diameter.cca.events.avp.CreditControlFailureHandlingType	getCreditControlFailureHandling() Returns the value of the Credit-Control-Failure-Handling AVP, of type Enumerated.
net.java.slee.resource.diameter.base.events.avp.FailedAvp[]	getFailedAvps() Returns the set of Failed-AVP AVPs.
net.java.slee.resource.diameter.base.events.avp.DiameterURI[]	getRedirectHosts() Returns the set of Redirect-Host AVPs.
net.java.slee.resource.diameter.base.events.avp.RedirectHostUsageType	getRedirectHostUsage() Returns the value of the Redirect-Host-Usage AVP, of type Enumerated.
long	getRedirectMaxCacheTime() Returns the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.
long	getResultCode() Returns the value of the Result-Code AVP, of type Unsigned32.
boolean	hasCcSessionFailover() Returns true if the CC-Session-Failover AVP is present in the message.
boolean	hasCostInformation() Returns true if the Cost-Information AVP is present in the message.
boolean	hasCreditControlFailureHandling() Returns true if the Credit-Control-Failure-Handling AVP is present in the message.
boolean	hasRedirectHostUsage() Returns true if the Redirect-Host-Usage AVP is present in the message.
boolean	hasRedirectMaxCacheTime() Returns true if the Redirect-Max-Cache-Time AVP is present in the message.
boolean	hasResultCode() Returns true if the Result-Code AVP is present in the message.
void	setCcSessionFailover(net.java.slee.resource.diameter.cca.events.avp.CcSessionFailoverType ccSessionFailover) Sets the value of the CC-Session-Failover AVP, of type Enumerated.
void	setCostInformation(net.java.slee.resource.diameter.cca.events.avp.CostInformationAvp costInformation) Sets the value of the Cost-Information AVP, of type Grouped.
void	setCreditControlFailureHandling(net.java.slee.resource.diameter.cca.events.avp.CreditControlFailureHandlingType creditControlFailureHandling) Sets the value of the Credit-Control-Failure-Handling AVP, of type Enumerated.
void	setFailedAvp(net.java.slee.resource.diameter.base.events.avp.FailedAvp failedAvp) Sets a single Failed-AVP AVP in the message, of type Grouped.
void	setFailedAvps(net.java.slee.resource.diameter.base.events.avp.FailedAvp[] failedAvps) Sets the set of Failed-AVP AVPs, with all the values in the given array.
void	setRedirectHost(net.java.slee.resource.diameter.base.events.avp.DiameterURI redirectHost) Sets a single Redirect-Host AVP in the message, of type DiameterURI.
void	setRedirectHosts(net.java.slee.resource.diameter.base.events.avp.DiameterURI[] redirectHosts) Sets the set of Redirect-Host AVPs, with all the values in the given array.
void	setRedirectHostUsage(net.java.slee.resource.diameter.base.events.avp.RedirectHostUsageType redirectHostUsage) Sets the value of the Redirect-Host-Usage AVP, of type Enumerated.
void	setRedirectMaxCacheTime(long redirectMaxCacheTime) Sets the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.
void	setResultCode(long resultCode) Sets the value of the Result-Code AVP, of type Unsigned32.

Methods inherited from interface net.java.slee.resource.diameter.ro.events.RoCreditControlMessage

getAuthApplicationId, getCcRequestNumber, getCcRequestType, getMultipleServicesCreditControls, getProxyInfos, getRouteRecords, getServiceInformation, hasAuthApplicationId, hasCcRequestNumber, hasCcRequestType, hasMultipleServicesCreditControl, hasServiceInformation, setAuthApplicationId, setCcRequestNumber, setCcRequestType, setMultipleServicesCreditControl, setMultipleServicesCreditControls, setProxyInfo, setProxyInfos, setRouteRecord, setRouteRecords, setServiceInformation

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

clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getExtensionAvps, getHeader, getOriginHost, getOriginRealm, getSessionId, hasDestinationHost, hasDestinationRealm, hasOriginHost, hasOriginRealm, hasSessionId, setDestinationHost, setDestinationRealm, setExtensionAvps, setOriginHost, setOriginRealm, setSessionId

Method Detail

hasResultCode

boolean hasResultCode()

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

getResultCode

long getResultCode()

Returns the value of the Result-Code AVP, of type Unsigned32. Use hasResultCode() to check the existence of this AVP.

Returns:

the value of the Result-Code AVP

Throws:

java.lang.IllegalStateException - if the Result-Code AVP has not been set on this message

setResultCode

void setResultCode(long resultCode)

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

Throws:

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

getCcSessionFailover

net.java.slee.resource.diameter.cca.events.avp.CcSessionFailoverType getCcSessionFailover()

Returns the value of the CC-Session-Failover AVP, of type Enumerated.

Returns:

setCcSessionFailover

void setCcSessionFailover(net.java.slee.resource.diameter.cca.events.avp.CcSessionFailoverType ccSessionFailover)
                          throws java.lang.IllegalStateException

Sets the value of the CC-Session-Failover AVP, of type Enumerated.

Parameters:

ccSessionFailover -

Throws:

java.lang.IllegalStateException

hasCcSessionFailover

boolean hasCcSessionFailover()

Returns true if the CC-Session-Failover AVP is present in the message.

Returns:

getCostInformation

net.java.slee.resource.diameter.cca.events.avp.CostInformationAvp getCostInformation()

Returns the value of the Cost-Information AVP, of type Grouped.

Returns:

setCostInformation

void setCostInformation(net.java.slee.resource.diameter.cca.events.avp.CostInformationAvp costInformation)
                        throws java.lang.IllegalStateException

Sets the value of the Cost-Information AVP, of type Grouped.

Parameters:

costInformation -

Throws:

java.lang.IllegalStateException

hasCostInformation

boolean hasCostInformation()

Returns true if the Cost-Information AVP is present in the message.

Returns:

getCreditControlFailureHandling

net.java.slee.resource.diameter.cca.events.avp.CreditControlFailureHandlingType getCreditControlFailureHandling()

Returns the value of the Credit-Control-Failure-Handling AVP, of type Enumerated.

Returns:

setCreditControlFailureHandling

void setCreditControlFailureHandling(net.java.slee.resource.diameter.cca.events.avp.CreditControlFailureHandlingType creditControlFailureHandling)
                                     throws java.lang.IllegalStateException

Sets the value of the Credit-Control-Failure-Handling AVP, of type Enumerated.

Parameters:

creditControlFailureHandling -

Throws:

java.lang.IllegalStateException

hasCreditControlFailureHandling

boolean hasCreditControlFailureHandling()

Returns true if the Credit-Control-Failure-Handling AVP is present in the message.

Returns:

getRedirectHosts

net.java.slee.resource.diameter.base.events.avp.DiameterURI[] getRedirectHosts()

Returns the set of Redirect-Host AVPs.

Returns:

setRedirectHost

void setRedirectHost(net.java.slee.resource.diameter.base.events.avp.DiameterURI redirectHost)
                     throws java.lang.IllegalStateException

Sets a single Redirect-Host AVP in the message, of type DiameterURI.

Parameters:

redirectHost -

Throws:

java.lang.IllegalStateException

setRedirectHosts

void setRedirectHosts(net.java.slee.resource.diameter.base.events.avp.DiameterURI[] redirectHosts)
                      throws java.lang.IllegalStateException

Sets the set of Redirect-Host AVPs, with all the values in the given array.

Parameters:

redirectHosts -

Throws:

java.lang.IllegalStateException

getRedirectHostUsage

net.java.slee.resource.diameter.base.events.avp.RedirectHostUsageType getRedirectHostUsage()

Returns the value of the Redirect-Host-Usage AVP, of type Enumerated.

Returns:

setRedirectHostUsage

void setRedirectHostUsage(net.java.slee.resource.diameter.base.events.avp.RedirectHostUsageType redirectHostUsage)
                          throws java.lang.IllegalStateException

Sets the value of the Redirect-Host-Usage AVP, of type Enumerated.

Parameters:

redirectHostUsage -

Throws:

java.lang.IllegalStateException

hasRedirectHostUsage

boolean hasRedirectHostUsage()

Returns true if the Redirect-Host-Usage AVP is present in the message.

Returns:

getRedirectMaxCacheTime

long getRedirectMaxCacheTime()

Returns the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.

Returns:

setRedirectMaxCacheTime

void setRedirectMaxCacheTime(long redirectMaxCacheTime)
                             throws java.lang.IllegalStateException

Sets the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.

Parameters:

redirectMaxCacheTime -

Throws:

java.lang.IllegalStateException

hasRedirectMaxCacheTime

boolean hasRedirectMaxCacheTime()

Returns true if the Redirect-Max-Cache-Time AVP is present in the message.

Returns:

getFailedAvps

net.java.slee.resource.diameter.base.events.avp.FailedAvp[] getFailedAvps()

Returns the set of Failed-AVP AVPs.

Returns:

setFailedAvp

void setFailedAvp(net.java.slee.resource.diameter.base.events.avp.FailedAvp failedAvp)
                  throws java.lang.IllegalStateException

Sets a single Failed-AVP AVP in the message, of type Grouped.

Parameters:

failedAvp -

Throws:

java.lang.IllegalStateException

setFailedAvps

void setFailedAvps(net.java.slee.resource.diameter.base.events.avp.FailedAvp[] failedAvps)
                   throws java.lang.IllegalStateException

Sets the set of Failed-AVP AVPs, with all the values in the given array.

Parameters:

failedAvps -

Throws:

java.lang.IllegalStateException