oracle.communication.brm.charging.messages.query

Interface UserDataRequestBuilder

public interface UserDataRequestBuilder

Interface for building well formed instance of UserDataRequest

Method Summary

Modifier and Type	Method and Description
UserDataRequest	build() Returns an instance of a UserDataRequest which was constructed using the builder
UserDataRequestBuilder	withCustomerExtendedInfo(java.util.Collection<java.lang.String> customerExtendedInfo) Sets the additional attributes of the Customer in the UserDataRequest.
UserDataRequestBuilder	withDataReferences(java.util.Collection<java.lang.Integer> dataReferences) Sets the data-references in the UserDataRequest.
UserDataRequestBuilder	withPreferences(java.util.Collection<java.lang.String> preferences) Sets the preferences in the UserDataRequest.
UserDataRequestBuilder	withProductExtendedInfo(java.util.Collection<java.lang.String> productExtendedInfo) Sets the additional attributes of the product in the UserDataRequest.
UserDataRequestBuilder	withProductType(java.lang.String productType) Sets the ProductType in the UserDataRequest.
UserDataRequestBuilder	withRequestTime(java.time.ZonedDateTime requestTime) Sets request time in the UserDataRequest.
UserDataRequestBuilder	withUserIdentity(java.lang.String userIdentity) Sets the user identity in the UserDataRequest.

Method Detail

withUserIdentity

UserDataRequestBuilder withUserIdentity(java.lang.String userIdentity)

Sets the user identity in the UserDataRequest. This is a mandatory field

Equivalent diameter AVP : Public-Identity

Parameters:

userIdentity - PublicUserIdentity of the product. Eg. 6500001

Returns:

the current builder to support chaining construct.

withProductType

UserDataRequestBuilder withProductType(java.lang.String productType)

Sets the ProductType in the UserDataRequest. This is a optional field

Equivalent diameter AVP : Service-Indication

Parameters:

productType - product type. Eg: DATA

Returns:

the current builder to support chaining construct.

withPreferences

UserDataRequestBuilder withPreferences(java.util.Collection<java.lang.String> preferences)

Sets the preferences in the UserDataRequest. This is a optional field

Parameters:

preferences - collection of preference names. Eg: [Chanel, Language]

Returns:

the current builder to support chaining construct.

withRequestTime

UserDataRequestBuilder withRequestTime(java.time.ZonedDateTime requestTime)

Sets request time in the UserDataRequest. This is a Mandatory field

Parameters:

requestTime - request time Eg. 2013-11-01T00:01:00

Returns:

the current builder to support chaining construct.

withCustomerExtendedInfo

UserDataRequestBuilder withCustomerExtendedInfo(java.util.Collection<java.lang.String> customerExtendedInfo)

Sets the additional attributes of the Customer in the UserDataRequest. This is a optional field

Parameters:

customerExtendedInfo - collection of aliases for customer attributes configured in ECE.
For more information please refer ECE docs.
Eg. [ratingProfileCorporate]

Returns:

the current builder to support chaining construct.

withProductExtendedInfo

UserDataRequestBuilder withProductExtendedInfo(java.util.Collection<java.lang.String> productExtendedInfo)

Sets the additional attributes of the product in the UserDataRequest. This is a optional field

Parameters:

productExtendedInfo - collection of aliases for product attributes configured in ECE.
For more information please refer ECE docs
Eg. [lifeCycleStateName, publicIdentifiers]

Returns:

the current builder to support chaining construct.

withDataReferences

UserDataRequestBuilder withDataReferences(java.util.Collection<java.lang.Integer> dataReferences)

Sets the data-references in the UserDataRequest. Data-references are numbers sent by the diameter which map to a preference or extended info in ECE.

Equivalent diameter AVP : Data-Reference

Parameters:

dataReferences - collection of data reference numbers. Eg: [51,52]

Returns:

the current builder to support chaining construct.

build

UserDataRequest build()
               throws MessagesQueryException

Returns an instance of a UserDataRequest which was constructed using the builder

Returns:

an instance of a UserDataRequest created using the builder

Throws:

MessagesQueryException - if mandatory field's are not set