net.java.slee.resource.diameter.cca.events
Interface CreditControlAnswer

All Superinterfaces:

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

All Known Implementing Classes:

CreditControlAnswerImpl

public interface CreditControlAnswer
extends CreditControlMessage

 3.2.  Credit-Control-Answer (CCA) Command
   The Credit-Control-Answer message (CCA) is indicated by the command-
   code field being set to 272 and the ÔøΩRÔøΩ bit being cleared in the
   Command Flags field.  It is used between the credit-control server
   and the Diameter credit-control client to acknowledge a Credit-
   Control-Request command.
   Message Format
       ::= < Diameter Header: 272, PXY >
                                  < Session-Id >
                                  { Result-Code }
                                  { Origin-Host }
                                  { Origin-Realm }
                                  { Auth-Application-Id }
                                  { CC-Request-Type }
                                  { CC-Request-Number }
                                  [ User-Name ]
                                  [ CC-Session-Failover ]
                                  [ CC-Sub-Session-Id ]
                                  [ Acct-Multi-Session-Id ]
                                  [ Origin-State-Id ]
                                  [ Event-Timestamp ]
                                  [ Granted-Service-Unit ]
                                 *[ Multiple-Services-Credit-Control ]
                                  [ Cost-Information]
                                  [ Final-Unit-Indication ]
                                  [ Check-Balance-Result ]
                                  [ Credit-Control-Failure-Handling ]
                                  [ Direct-Debiting-Failure-Handling ]
                                  [ Validity-Time]
                                 *[ Redirect-Host]
                                  [ Redirect-Host-Usage ]
                                  [ Redirect-Max-Cache-Time ]
                                 *[ Proxy-Info ]
                                 *[ Route-Record ]
                                 *[ Failed-AVP ]
                                 *[ AVP ]
 

Author:

Alexandre MendonÔøΩa

Field Summary

Fields inherited from interface net.java.slee.resource.diameter.cca.events.CreditControlMessage

commandCode

Method Summary

CcSessionFailoverType	getCcSessionFailover() Returns the value of the CC-Session-Failover AVP, of type Enumerated.
CheckBalanceResultType	getCheckBalanceResult() Returns the value of the Check-Balance-Result AVP, of type Enumerated.
CostInformationAvp	getCostInformation() Returns the value of the Cost-Information AVP, of type Grouped.
CreditControlFailureHandlingType	getCreditControlFailureHandling() Returns the value of the Credit-Control-Failure-Handling AVP, of type Enumerated.
DirectDebitingFailureHandlingType	getDirectDebitingFailureHandling() Returns the value of the Direct-Debiting-Failure-Handling AVP, of type Enumerated.
net.java.slee.resource.diameter.base.events.avp.FailedAvp[]	getFailedAvps() Returns the set of Failed-AVP AVPs.
FinalUnitIndicationAvp	getFinalUnitIndication() Returns the value of the Final-Unit-Indication AVP, of type Grouped.
GrantedServiceUnitAvp	getGrantedServiceUnit() Returns the value of the Granted-Service-Unit AVP, of type Grouped.
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.
long	getValidityTime() Returns the value of the Validity-Time AVP, of type Unsigned32.
boolean	hasCcSessionFailover() Returns true if the CC-Session-Failover AVP is present in the message.
boolean	hasCheckBalanceResult() Returns true if the Check-Balance-Result 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	hasDirectDebitingFailureHandling() Returns true if the Direct-Debiting-Failure-Handling AVP is present in the message.
boolean	hasFinalUnitIndication() Returns true if the Final-Unit-Indication AVP is present in the message.
boolean	hasGrantedServiceUnit() Returns true if the Granted-Service-Unit 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.
boolean	hasValidityTime() Returns true if the Validity-Time AVP is present in the message.
void	setCcSessionFailover(CcSessionFailoverType ccSessionFailover) Sets the value of the CC-Session-Failover AVP, of type Enumerated.
void	setCheckBalanceResult(CheckBalanceResultType checkBalanceResult) Sets the value of the Check-Balance-Result AVP, of type Enumerated.
void	setCostInformation(CostInformationAvp costInformation) Sets the value of the Cost-Information AVP, of type Grouped.
void	setCreditControlFailureHandling(CreditControlFailureHandlingType creditControlFailureHandling) Sets the value of the Credit-Control-Failure-Handling AVP, of type Enumerated.
void	setDirectDebitingFailureHandling(DirectDebitingFailureHandlingType directDebitingFailureHandling) Sets the value of the Direct-Debiting-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	setFinalUnitIndication(FinalUnitIndicationAvp finalUnitIndication) Sets the value of the Final-Unit-Indication AVP, of type Grouped.
void	setGrantedServiceUnit(GrantedServiceUnitAvp grantedServiceUnit) Sets the value of the Granted-Service-Unit AVP, of type Grouped.
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.
void	setValidityTime(long validityTime) Sets the value of the Validity-Time AVP, of type Unsigned32.

Methods inherited from interface net.java.slee.resource.diameter.cca.events.CreditControlMessage

getAcctMultiSessionId, getAuthApplicationId, getCcRequestNumber, getCcRequestType, getCcSubSessionId, getEventTimestamp, getMultipleServicesCreditControls, getOriginStateId, getProxyInfos, getRouteRecords, getUserName, hasAcctMultiSessionId, hasAuthApplicationId, hasCcRequestNumber, hasCcRequestType, hasCcSubSessionId, hasEventTimestamp, hasMultipleServicesCreditControl, hasOriginStateId, hasUserName, setAcctMultiSessionId, setAuthApplicationId, setCcRequestNumber, setCcRequestType, setCcSubSessionId, setEventTimestamp, setMultipleServicesCreditControl, setMultipleServicesCreditControls, setOriginStateId, setProxyInfo, setProxyInfos, setRouteRecord, setRouteRecords, setUserName

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

getCcSessionFailover

CcSessionFailoverType getCcSessionFailover()

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

Returns:

setCcSessionFailover

void setCcSessionFailover(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:

getCheckBalanceResult

CheckBalanceResultType getCheckBalanceResult()

Returns the value of the Check-Balance-Result AVP, of type Enumerated.

Returns:

setCheckBalanceResult

void setCheckBalanceResult(CheckBalanceResultType checkBalanceResult)
                           throws java.lang.IllegalStateException

Sets the value of the Check-Balance-Result AVP, of type Enumerated.

Parameters:

checkBalanceResult -

Throws:

java.lang.IllegalStateException

hasCheckBalanceResult

boolean hasCheckBalanceResult()

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

Returns:

getCostInformation

CostInformationAvp getCostInformation()

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

Returns:

setCostInformation

void setCostInformation(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

CreditControlFailureHandlingType getCreditControlFailureHandling()

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

Returns:

setCreditControlFailureHandling

void setCreditControlFailureHandling(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:

getDirectDebitingFailureHandling

DirectDebitingFailureHandlingType getDirectDebitingFailureHandling()

Returns the value of the Direct-Debiting-Failure-Handling AVP, of type Enumerated.

Returns:

setDirectDebitingFailureHandling

void setDirectDebitingFailureHandling(DirectDebitingFailureHandlingType directDebitingFailureHandling)
                                      throws java.lang.IllegalStateException

Sets the value of the Direct-Debiting-Failure-Handling AVP, of type Enumerated.

Parameters:

directDebitingFailureHandling -

Throws:

java.lang.IllegalStateException

hasDirectDebitingFailureHandling

boolean hasDirectDebitingFailureHandling()

Returns true if the Direct-Debiting-Failure-Handling 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

getFinalUnitIndication

FinalUnitIndicationAvp getFinalUnitIndication()

Returns the value of the Final-Unit-Indication AVP, of type Grouped.

Returns:

setFinalUnitIndication

void setFinalUnitIndication(FinalUnitIndicationAvp finalUnitIndication)
                            throws java.lang.IllegalStateException

Sets the value of the Final-Unit-Indication AVP, of type Grouped.

Parameters:

finalUnitIndication -

Throws:

java.lang.IllegalStateException

hasFinalUnitIndication

boolean hasFinalUnitIndication()

Returns true if the Final-Unit-Indication AVP is present in the message.

Returns:

getGrantedServiceUnit

GrantedServiceUnitAvp getGrantedServiceUnit()

Returns the value of the Granted-Service-Unit AVP, of type Grouped.

Returns:

setGrantedServiceUnit

void setGrantedServiceUnit(GrantedServiceUnitAvp grantedServiceUnit)
                           throws java.lang.IllegalStateException

Sets the value of the Granted-Service-Unit AVP, of type Grouped.

Parameters:

grantedServiceUnit -

Throws:

java.lang.IllegalStateException

hasGrantedServiceUnit

boolean hasGrantedServiceUnit()

Returns true if the Granted-Service-Unit 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:

getResultCode

long getResultCode()

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

Returns:

setResultCode

void setResultCode(long resultCode)
                   throws java.lang.IllegalStateException

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

Parameters:

resultCode -

Throws:

java.lang.IllegalStateException

hasResultCode

boolean hasResultCode()

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

Returns:

getValidityTime

long getValidityTime()

Returns the value of the Validity-Time AVP, of type Unsigned32.

Returns:

setValidityTime

void setValidityTime(long validityTime)
                     throws java.lang.IllegalStateException

Sets the value of the Validity-Time AVP, of type Unsigned32.

Parameters:

validityTime -

Throws:

java.lang.IllegalStateException

hasValidityTime

boolean hasValidityTime()

Returns true if the Validity-Time AVP is present in the message.

Returns: