Package oracle.communication.brm.charging.messages.policy

Interface PolicySessionRequestBuilder

All Superinterfaces:
PolicyRequestBuilder<PolicySessionRequest.RequestType,PolicySessionRequestBuilder>
public interface PolicySessionRequestBuilder extends PolicyRequestBuilder<PolicySessionRequest.RequestType,PolicySessionRequestBuilder>
Interface for building well formed instance of PolicySessionRequest

  • Method Details

    • withPreferences

      PolicySessionRequestBuilder withPreferences(Collection<String> preferences)
      Sets the preferences in the PolicyRequest. This is an optional field.
      Parameters:
      preferences - set of preferences to be subscribed/un-subscribed (eg. [Chanel, Language])
      Returns:
      the current builder to support chaining construct.

    • withExpiryTime

      PolicySessionRequestBuilder withExpiryTime(ZonedDateTime expiryTime)
      Sets the expiry time in the PolicyRequest. This is an optional field.
    • The absence of this field in the request will lead to infinite subscription for the subscriber notification
      • Parameters:
      expiryTime - date when subscription should cease
      Returns:
      the current builder to support chaining construct.

    • withSessionId

      PolicySessionRequestBuilder withSessionId(String sessionId)
      Sets the session id in the PolicyRequest. This is a mandatory field.
    • This is a unique identifier associated throughout the life of a ongoing Sy session
      • Specified by:
      withSessionId in interface PolicyRequestBuilder<PolicySessionRequest.RequestType,PolicySessionRequestBuilder>
      Parameters:
      sessionId - unique identifier associated with the request (eg. SESSION-001)
      Returns:
      the current builder to support chaining construct.

    • withPolicyCounters

      PolicySessionRequestBuilder withPolicyCounters(Collection<String> policyCounters)
      Sets the policy counters in the PolicyRequest. This is an optional field.
    • The list of the counters which will be considered for subscription for future threshold breach reporting.
    • If the field not provided in the input request then all the counters for the subscriber will be subscribed for future threshold breach reporting.
      • Parameters:
      policyCounters - collection of policy counters (eg. [USD, FREE_MINS])
      Returns:
      the current builder to support chaining construct.

    • withUserIds

      PolicySessionRequestBuilder withUserIds(Collection<String> userIds)
      Sets the userIds in the PolicyRequest.
    • The list of the Subscription User Ids from request.
    • Parameters:
      userIds - collection of userIds
      Returns:
      the current builder to support chaining construct.