oracle.communication.brm.charging.messages.usage

Interface UsageRequest

All Superinterfaces:

Request<Usage>, java.io.Serializable

public interface UsageRequest
extends Request<Usage>

Class represents a UsageRequest which is processed by the ECE Charging Service.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AMOUNT_NAME
static java.lang.String	BALANCE_ELEMENT_ID_NAME
static java.lang.String	CO_RELATION_IDENTIFIER_NAME
static java.lang.String	IMPACT_AMOUNT_BLOCK_NAME
static java.lang.String	REQUESTED_UNITS
static java.lang.String	TARIFF_CHANGE_USAGE
static int	TARIFF_CHANGE_USAGE_AFTER_TTC
static int	TARIFF_CHANGE_USAGE_BEFORE_TTC
static java.lang.String	USED_UNITS_BLOCK

Method Summary

Modifier and Type	Method and Description
UsageRequest	convertToTerminate(Usage requestType) Method to create a TERMINATE Usage Request from the current original UsageRequest.
UsageRequest	convertToTerminate(Usage requestType, java.time.ZonedDateTime requestStartTime, java.time.ZonedDateTime requestEnd, boolean isMultipleUSU, boolean isBeforeTTC, java.lang.String sessionIdOverridenForLifeCycleUpdate) Method to create a TERMINATE Usage Request from the current original UsageRequest.
UsageRequest	convertToTerminateZeroUsedUnit(Usage requestType, java.time.ZonedDateTime requestStartTime, java.time.ZonedDateTime requestEnd, boolean isMultipleUSU, boolean isBeforeTTC, java.lang.String sessionIdOverridenForLifeCycleUpdate)
java.lang.String	getDurationAttributeName() Gets the name of the USU field that tracks DURATION usage for session based charging.
java.lang.String	getEventType() get the event type associated with the usageRequest.
java.lang.String	getProductType() get the product type associated with the usageRequest.
java.lang.Long	getQtyPropBasedOnCreditBreach(BigDecimalFraction proportion, boolean isDurationRumPresent, long configuredValidity, long tariffSwitchTime, long unratedDuration, boolean ifWorstCostImpacted, long ratedDurationInMillis, boolean isQuotaAttributePresent, int randomizationInterval) Get the expiration date and time in case of reverse rating (ONLY)
java.lang.Boolean	getRatingConditionChange()
java.lang.String	getReportingReason() get the requestId associated with the UsageRequest.
java.lang.String	getRequestId() get the requestId associated with the UsageRequest.
RequestMode	getRequestMode() Getter
int	getSequenceNumber() get the sequence number for this usage request.
boolean	getTraced() get the subscriber trace flag
UnitReportingMode	getUnitReportingMode()
java.lang.String	getVersion() Get the version of the usage request
void	resolve(UsageRequest oldUsageRequest, UsageRequest newUsageRequest, boolean isInternalOverride) Conflict logic to resolve between 2 usage request across clusters.
void	setReportingReason(java.lang.String reportingReason) sets the Reporting-Reason
void	setTraced(boolean traced) Set the subscriber trace flag
UsageRequest	withDateTimes(java.time.ZonedDateTime requestStart, java.time.ZonedDateTime requestEnd) Method to create a new UsageRequest from the current request using the supplied payload.
UsageRequest	withRequestId(java.lang.String newRequestId) New UsageRequest with specified newRequestId.

Methods inherited from interface oracle.communication.brm.charging.messages.framework.Request

getOperation, getPayload, getStatus

Field Detail

IMPACT_AMOUNT_BLOCK_NAME

static final java.lang.String IMPACT_AMOUNT_BLOCK_NAME

See Also:

Constant Field Values

BALANCE_ELEMENT_ID_NAME

static final java.lang.String BALANCE_ELEMENT_ID_NAME

See Also:

Constant Field Values

AMOUNT_NAME

static final java.lang.String AMOUNT_NAME

See Also:

Constant Field Values

CO_RELATION_IDENTIFIER_NAME

static final java.lang.String CO_RELATION_IDENTIFIER_NAME

See Also:

Constant Field Values

REQUESTED_UNITS

static final java.lang.String REQUESTED_UNITS

See Also:

Constant Field Values

USED_UNITS_BLOCK

static final java.lang.String USED_UNITS_BLOCK

See Also:

Constant Field Values

TARIFF_CHANGE_USAGE

static final java.lang.String TARIFF_CHANGE_USAGE

See Also:

Constant Field Values

TARIFF_CHANGE_USAGE_BEFORE_TTC

static final int TARIFF_CHANGE_USAGE_BEFORE_TTC

See Also:

Constant Field Values

TARIFF_CHANGE_USAGE_AFTER_TTC

static final int TARIFF_CHANGE_USAGE_AFTER_TTC

See Also:

Constant Field Values

Method Detail

getRequestId

java.lang.String getRequestId()

get the requestId associated with the UsageRequest. This unique session Id is constant across all INITIATE, UPDATE and TERMINATES corresponding to the same session.

Returns:

the sessionId

getReportingReason

java.lang.String getReportingReason()

get the requestId associated with the UsageRequest. This unique session Id is constant across all INITIATE, UPDATE and TERMINATES corresponding to the same session.

Returns:

the reportingReason

setReportingReason

void setReportingReason(java.lang.String reportingReason)

sets the Reporting-Reason

getProductType

java.lang.String getProductType()

get the product type associated with the usageRequest.

Returns:

getEventType

java.lang.String getEventType()

get the event type associated with the usageRequest.

Returns:

setTraced

void setTraced(boolean traced)

Set the subscriber trace flag

getTraced

boolean getTraced()

get the subscriber trace flag

Returns:

true if the subscriber request is to be traced or false

getSequenceNumber

int getSequenceNumber()

get the sequence number for this usage request. Multiple UsageRequest corresponding to the same session will have their sequence number incremented each time.

Returns:

the sequence number for this usage request

getRatingConditionChange

java.lang.Boolean getRatingConditionChange()

Returns:

The flag representing if there is rating condition change

getUnitReportingMode

UnitReportingMode getUnitReportingMode()

Returns:

The Unit Reporting Mode of this usage Request.

withDateTimes

UsageRequest withDateTimes(java.time.ZonedDateTime requestStart,
                           java.time.ZonedDateTime requestEnd)

Method to create a new UsageRequest from the current request using the supplied payload. Values from the request will be used by default. Only the values passed in parameters will be over written.

Parameters:

requestStart - session start time

requestEnd - request end time

Returns:

enriched Usage Request

getVersion

java.lang.String getVersion()

Get the version of the usage request

Returns:

version

getDurationAttributeName

java.lang.String getDurationAttributeName()

Gets the name of the USU field that tracks DURATION usage for session based charging.

Returns:

the name of the USU field for tracking DURATION. Will return null if the UsageRequest does not contain fields for DURATION based charging.

getQtyPropBasedOnCreditBreach

java.lang.Long getQtyPropBasedOnCreditBreach(BigDecimalFraction proportion,
                                             boolean isDurationRumPresent,
                                             long configuredValidity,
                                             long tariffSwitchTime,
                                             long unratedDuration,
                                             boolean ifWorstCostImpacted,
                                             long ratedDurationInMillis,
                                             boolean isQuotaAttributePresent,
                                             int randomizationInterval)

Get the expiration date and time in case of reverse rating (ONLY)

Returns:

long value of the duration to the end time after being adjusted with the proportion in seconds

withRequestId

UsageRequest withRequestId(java.lang.String newRequestId)

New UsageRequest with specified newRequestId. All other properties are retained

Parameters:

newRequestId - newRequestId

Returns:

UsageRequest UsageRequest

convertToTerminate

UsageRequest convertToTerminate(Usage requestType)

Method to create a TERMINATE Usage Request from the current original UsageRequest. This is used during the ASO Cleanup, Mid session CDR operation and Management Accounting on/off.

Parameters:

requestType - request type

Returns:

new forcefully created TERMINATE request

resolve

void resolve(UsageRequest oldUsageRequest,
             UsageRequest newUsageRequest,
             boolean isInternalOverride)

Conflict logic to resolve between 2 usage request across clusters.

Parameters:

oldUsageRequest -

newUsageRequest -

getRequestMode

RequestMode getRequestMode()

Getter

Returns:

to get the request mode (ONLINE or OFFLINE)

convertToTerminate

UsageRequest convertToTerminate(Usage requestType,
                                java.time.ZonedDateTime requestStartTime,
                                java.time.ZonedDateTime requestEnd,
                                boolean isMultipleUSU,
                                boolean isBeforeTTC,
                                java.lang.String sessionIdOverridenForLifeCycleUpdate)

Method to create a TERMINATE Usage Request from the current original UsageRequest. This is used during the ASO Cleanup, Mid session CDR operation and Management Accounting on/off.

Parameters:

requestType - request type

sessionIdOverridenForLifeCycleUpdate -

Returns:

new forcefully created TERMINATE request

convertToTerminateZeroUsedUnit

UsageRequest convertToTerminateZeroUsedUnit(Usage requestType,
                                            java.time.ZonedDateTime requestStartTime,
                                            java.time.ZonedDateTime requestEnd,
                                            boolean isMultipleUSU,
                                            boolean isBeforeTTC,
                                            java.lang.String sessionIdOverridenForLifeCycleUpdate)

Parameters:

requestType -

requestStartTime -

requestEnd -

isMultipleUSU -

isBeforeTTC -

sessionIdOverridenForLifeCycleUpdate -

Returns: