Package oracle.communication.brm.charging.messages.query

Interface UserDataResponse

All Superinterfaces:
QueryResponse, Response<Query>, Serializable
public interface UserDataResponse extends QueryResponse
Class defining the UserData response structure.

UserDataResponse is the response generated by ECE for UserDataRequest
It contains preference values for input preference names

Implementation of User-Data-Answer as specified in 3GPP TS 29.329
Diameter command Code : 306

  • Method Details

    • getCustomerId

      String getCustomerId()
      Fetches the customer id
    • Eg. 650001
      • Returns:
      customer id

    • getCommonPreferences

      Map<String,String> getCommonPreferences()
      Fetches the common preferences which are applicable for all the products of the customer
    • Eg. [Language:English]

      Diameter AVP Name : User-Data

      • Returns:
      common preferences;

    • getProductPreferences

      Map<String,UserDataResponse.ProductPreference> getProductPreferences()
      Fetches the product preferences with productType as key
    • Eg. [DATA:UserDataResponse.ProductPreference]

      Diameter AVP Name : User-Data

      • Returns:
      Map of product preferences

    • getUnsupportedPreferences

      Collection<String> getUnsupportedPreferences()
      Fetches the collection of unsupported preferences.
    • There are the preference names that are not configured for the specified product/customer
    • Eg. [InvalidPref]
      • Returns:
      a collection of invalid preferences

    • getCustomerExtendedInfo

      Map<String,Object> getCustomerExtendedInfo()
      Fetches the customer extended information map with extended info as key and the result as value
    • Eg. [ratingProfileCorporate: [18000001, 1800002]]
      • Returns:
      map of customer extended information

    • getProductExtendedInfo

      Map<String,Map<String,Object>> getProductExtendedInfo()
      Fetches the product extended information map with product type as key and extended info map as value with extended info as key and the result as value
    • Eg. [DATA: [lifeCycleStateName: ACTIVE, ratingProfileFriends: [9886001, 9886002]], VOICE: [lifeCycleStateName: PREACTIVE]]
      • Returns:
      map of product extended information

    • getCustomer

      oracle.communication.brm.charging.customer.Customer getCustomer()
      Used for fetching the customer as part of user data response
      Returns:
      @Customer.