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

All Superinterfaces:

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

All Known Implementing Classes:

RoCreditControlRequestImpl

public interface RoCreditControlRequest
extends RoCreditControlMessage

Interface for RoCreditControlRequest type of message. It has following structure:

      ::= < Diameter Header: 272, REQ, PXY >
             < Session-Id > 
                  { Origin-Host } 
                  { Origin-Realm } 
                  { Destination-Realm } 
                  { Auth-Application-Id }
                  { Service-Context-Id } 
                  { CC-Request-Type } 
                  { CC-Request-Number } 
                  [ Destination-Host ] 
                  [ User-Name ] 
                  [ Origin-State-Id ] 
                  [ Event-Timestamp ] 
                 *[ Subscription-Id ]  
                  [ Termination-Cause ] 
                  [ Requested-Action ] 
                  [ Multiple-Services-Indicator ] 
                 *[ Multiple-Services-Credit-Control ]  
                  [ User-Equipment-Info ] 
                 *[ Proxy-Info ]
                 *[ Route-Record ]
             [ Service-Information ]
                 *[ AVP ]
 

Author:

Bartosz Baranowski , Alexandre Mendonca

Field Summary

static int

commandCode

Method Summary

java.util.Date	getEventTimestamp() Returns the value of the Event-Timestamp AVP, of type Time.
net.java.slee.resource.diameter.cca.events.avp.MultipleServicesIndicatorType	getMultipleServicesIndicator() Returns the value of the Multiple-Services-Indicator AVP, of type Enumerated.
long	getOriginStateId() Returns the value of the Origin-State-Id AVP, of type Unsigned32.
net.java.slee.resource.diameter.cca.events.avp.RequestedActionType	getRequestedAction() Returns the value of the Requested-Action AVP, of type Enumerated.
java.lang.String	getServiceContextId() Returns the value of the Service-Context-Id AVP, of type UTF8String.
net.java.slee.resource.diameter.cca.events.avp.SubscriptionIdAvp[]	getSubscriptionIds() Returns the set of Subscription-Id AVPs.
net.java.slee.resource.diameter.base.events.avp.TerminationCauseType	getTerminationCause() Returns the value of the Termination-Cause AVP, of type Enumerated.
net.java.slee.resource.diameter.cca.events.avp.UserEquipmentInfoAvp	getUserEquipmentInfo() Returns the value of the User-Equipment-Info AVP, of type Grouped.
java.lang.String	getUserName() Returns the value of the User-Name AVP, of type UTF8String.
boolean	hasEventTimestamp() Returns true if the Event-Timestamp AVP is present in the message.
boolean	hasMultipleServicesIndicator() Returns true if the Multiple-Services-Indicator AVP is present in the message.
boolean	hasOriginStateId() Returns true if the Origin-State-Id AVP is present in the message.
boolean	hasRequestedAction() Returns true if the Requested-Action AVP is present in the message.
boolean	hasServiceContextId() Returns true if the Service-Context-Id AVP is present in the message.
boolean	hasTerminationCause() Returns true if the Termination-Cause AVP is present in the message.
boolean	hasUserEquipmentInfo() Returns true if the User-Equipment-Info AVP is present in the message.
boolean	hasUserName() Returns true if the User-Name AVP is present in the message.
void	setEventTimestamp(java.util.Date eventTimestamp) Sets the value of the Event-Timestamp AVP, of type Time.
void	setMultipleServicesIndicator(net.java.slee.resource.diameter.cca.events.avp.MultipleServicesIndicatorType multipleServicesIndicator) Sets the value of the Multiple-Services-Indicator AVP, of type Enumerated.
void	setOriginStateId(long originStateId) Sets the value of the Origin-State-Id AVP, of type Unsigned32.
void	setRequestedAction(net.java.slee.resource.diameter.cca.events.avp.RequestedActionType requestedAction) Sets the value of the Requested-Action AVP, of type Enumerated.
void	setServiceContextId(java.lang.String serviceContextId) Sets the value of the Service-Context-Id AVP, of type UTF8String.
void	setSubscriptionId(net.java.slee.resource.diameter.cca.events.avp.SubscriptionIdAvp subscriptionId) Sets a single Subscription-Id AVP in the message, of type Grouped.
void	setSubscriptionIds(net.java.slee.resource.diameter.cca.events.avp.SubscriptionIdAvp[] subscriptionIds) Sets the set of Subscription-Id AVPs, with all the values in the given array.
void	setTerminationCause(net.java.slee.resource.diameter.base.events.avp.TerminationCauseType terminationCause) Sets the value of the Termination-Cause AVP, of type Enumerated.
void	setUserEquipmentInfo(net.java.slee.resource.diameter.cca.events.avp.UserEquipmentInfoAvp userEquipmentInfo) Sets the value of the User-Equipment-Info AVP, of type Grouped.
void	setUserName(java.lang.String userName) Sets the value of the User-Name AVP, of type UTF8String.

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

Field Detail

commandCode

static final int commandCode

See Also:

Constant Field Values

Method Detail

getServiceContextId

java.lang.String getServiceContextId()

Returns the value of the Service-Context-Id AVP, of type UTF8String.

Returns:

setServiceContextId

void setServiceContextId(java.lang.String serviceContextId)
                         throws java.lang.IllegalStateException

Sets the value of the Service-Context-Id AVP, of type UTF8String.

Parameters:

serviceContextId -

Throws:

java.lang.IllegalStateException

hasServiceContextId

boolean hasServiceContextId()

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

Returns:

getUserName

java.lang.String getUserName()

Returns the value of the User-Name AVP, of type UTF8String.

Returns:

setUserName

void setUserName(java.lang.String userName)
                 throws java.lang.IllegalStateException

Sets the value of the User-Name AVP, of type UTF8String.

Parameters:

userName -

Throws:

java.lang.IllegalStateException

hasUserName

boolean hasUserName()

Returns true if the User-Name AVP is present in the message.

Returns:

getOriginStateId

long getOriginStateId()

Returns the value of the Origin-State-Id AVP, of type Unsigned32.

Returns:

setOriginStateId

void setOriginStateId(long originStateId)
                      throws java.lang.IllegalStateException

Sets the value of the Origin-State-Id AVP, of type Unsigned32.

Parameters:

originStateId -

Throws:

java.lang.IllegalStateException

hasOriginStateId

boolean hasOriginStateId()

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

Returns:

getEventTimestamp

java.util.Date getEventTimestamp()

Returns the value of the Event-Timestamp AVP, of type Time.

Returns:

setEventTimestamp

void setEventTimestamp(java.util.Date eventTimestamp)
                       throws java.lang.IllegalStateException

Sets the value of the Event-Timestamp AVP, of type Time.

Parameters:

eventTimestamp -

Throws:

java.lang.IllegalStateException

hasEventTimestamp

boolean hasEventTimestamp()

Returns true if the Event-Timestamp AVP is present in the message.

Returns:

getSubscriptionIds

net.java.slee.resource.diameter.cca.events.avp.SubscriptionIdAvp[] getSubscriptionIds()

Returns the set of Subscription-Id AVPs.

Returns:

setSubscriptionId

void setSubscriptionId(net.java.slee.resource.diameter.cca.events.avp.SubscriptionIdAvp subscriptionId)
                       throws java.lang.IllegalStateException

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

Parameters:

subscriptionId -

Throws:

java.lang.IllegalStateException

setSubscriptionIds

void setSubscriptionIds(net.java.slee.resource.diameter.cca.events.avp.SubscriptionIdAvp[] subscriptionIds)
                        throws java.lang.IllegalStateException

Sets the set of Subscription-Id AVPs, with all the values in the given array.

Parameters:

subscriptionIds -

Throws:

java.lang.IllegalStateException

getTerminationCause

net.java.slee.resource.diameter.base.events.avp.TerminationCauseType getTerminationCause()

Returns the value of the Termination-Cause AVP, of type Enumerated.

Returns:

setTerminationCause

void setTerminationCause(net.java.slee.resource.diameter.base.events.avp.TerminationCauseType terminationCause)
                         throws java.lang.IllegalStateException

Sets the value of the Termination-Cause AVP, of type Enumerated.

Parameters:

terminationCause -

Throws:

java.lang.IllegalStateException

hasTerminationCause

boolean hasTerminationCause()

Returns true if the Termination-Cause AVP is present in the message.

Returns:

getRequestedAction

net.java.slee.resource.diameter.cca.events.avp.RequestedActionType getRequestedAction()

Returns the value of the Requested-Action AVP, of type Enumerated.

Returns:

setRequestedAction

void setRequestedAction(net.java.slee.resource.diameter.cca.events.avp.RequestedActionType requestedAction)
                        throws java.lang.IllegalStateException

Sets the value of the Requested-Action AVP, of type Enumerated.

Parameters:

requestedAction -

Throws:

java.lang.IllegalStateException

hasRequestedAction

boolean hasRequestedAction()

Returns true if the Requested-Action AVP is present in the message.

Returns:

getMultipleServicesIndicator

net.java.slee.resource.diameter.cca.events.avp.MultipleServicesIndicatorType getMultipleServicesIndicator()

Returns the value of the Multiple-Services-Indicator AVP, of type Enumerated.

Returns:

setMultipleServicesIndicator

void setMultipleServicesIndicator(net.java.slee.resource.diameter.cca.events.avp.MultipleServicesIndicatorType multipleServicesIndicator)
                                  throws java.lang.IllegalStateException

Sets the value of the Multiple-Services-Indicator AVP, of type Enumerated.

Parameters:

multipleServicesIndicator -

Throws:

java.lang.IllegalStateException

hasMultipleServicesIndicator

boolean hasMultipleServicesIndicator()

Returns true if the Multiple-Services-Indicator AVP is present in the message.

Returns:

getUserEquipmentInfo

net.java.slee.resource.diameter.cca.events.avp.UserEquipmentInfoAvp getUserEquipmentInfo()

Returns the value of the User-Equipment-Info AVP, of type Grouped.

Returns:

setUserEquipmentInfo

void setUserEquipmentInfo(net.java.slee.resource.diameter.cca.events.avp.UserEquipmentInfoAvp userEquipmentInfo)
                          throws java.lang.IllegalStateException

Sets the value of the User-Equipment-Info AVP, of type Grouped.

Parameters:

userEquipmentInfo -

Throws:

java.lang.IllegalStateException

hasUserEquipmentInfo

boolean hasUserEquipmentInfo()

Returns true if the User-Equipment-Info AVP is present in the message.

Returns: