oracle.communication.brm.charging.messages.update

Interface UpdateRequest

All Superinterfaces:

Request<oracle.communication.brm.charging.messages.update.Update>, java.io.Serializable

All Known Subinterfaces:

AccountMigrationRequest, BalanceUpdateRequest, CreateReservationRequest, CustomerCommitUpdateRequest, CustomerDeleteUpdateRequest, CustomerUpdateRequest, DeleteReservationRequest, ExternalTopUpUpdateRequest, GetReservationRequest, OfferingUpdateRequest, OfferProfileRequest, ProductSharingAgreementUpdateRequest, ProfileSharingAgreementUpdateRequest, ProfileUpdateRequest, ReservationRequest, oracle.communication.brm.charging.messages.update.SharingAgreementUpdateReq, UpdateReservationRequest

public interface UpdateRequest
extends Request<oracle.communication.brm.charging.messages.update.Update>

Base update request class containing the operation and information messages across the different update request types.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UpdateRequest.ChargeSharing

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBusinessEvent() Method to return the business event associated to the update request
java.lang.String	getCustomerId() Get the customer identifier associated with the request.
java.util.Collection<java.lang.String>	getCustomerIds() Get the collection of customers associated with the request; default value is null.
java.time.ZonedDateTime	getEventDateTime()
java.lang.String	getMsgId() Unique id to map request with response
boolean	getTraced() get the subscriber trace flag
java.lang.String	getUserIdentity() Get the external customer id associated with this usage request.
boolean	isAsynchronous()
UpdateRequest.ChargeSharing	isChargeSharing() If this interface returns a UNKNOWN value, then while building envelope , identity repository will be looked-up to determine if the customer is transactional
boolean	isTransactional()
boolean	revisionCheck() Returns whether a revision check has to be done for this Update.
void	setAsynchronous(boolean isPostUpdate)
void	setCustomerId(java.lang.String customerId) Setter Mutate the customerId
void	setTraced(boolean traced) Set the subscriber trace flag
void	setTransactional(boolean transactional)

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

getOperation, getPayload, getStatus

Method Detail

getUserIdentity

java.lang.String getUserIdentity()

Get the external customer id associated with this usage request. For a voice usage request this could be a telephone number (ie. 14081234567).

Returns:

the user identify

getCustomerId

java.lang.String getCustomerId()

Get the customer identifier associated with the request.

Returns:

the customer identifier

getCustomerIds

java.util.Collection<java.lang.String> getCustomerIds()

Get the collection of customers associated with the request; default value is null. Used in cases like account Migration where multiple cistomers are involved.

Returns:

collection of customer Ids

isChargeSharing

UpdateRequest.ChargeSharing isChargeSharing()

If this interface returns a UNKNOWN value, then while building envelope , identity repository will be looked-up to determine if the customer is transactional

Returns:

UpdateRequest.ChargeSharing

revisionCheck

boolean revisionCheck()

Returns whether a revision check has to be done for this Update. Used in Update Catchup phase.

Returns:

true if revision check has to be enforced; otherwise false

getMsgId

java.lang.String getMsgId()

Unique id to map request with response

Returns:

the message identifier

getEventDateTime

java.time.ZonedDateTime getEventDateTime()

Returns:

Time of occurrence of the event

getBusinessEvent

java.lang.String getBusinessEvent()

Method to return the business event associated to the update request

Returns:

Business Event String

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

setCustomerId

void setCustomerId(java.lang.String customerId)

Setter Mutate the customerId

Parameters:

customerId -

setTransactional

void setTransactional(boolean transactional)

isTransactional

boolean isTransactional()

isAsynchronous

boolean isAsynchronous()

setAsynchronous

void setAsynchronous(boolean isPostUpdate)