oracle.communication.brm.charging.messages.policy

Interface PolicyRequestBuilder<S,T extends PolicyRequestBuilder>

All Known Subinterfaces:

PolicySessionRequestBuilder, SpendingLimitReportRequestBuilder, SubscribeNotificationRequestBuilder

public interface PolicyRequestBuilder<S,T extends PolicyRequestBuilder>

Base interface for all Policy Request Builders

Method Summary

Modifier and Type	Method and Description
PolicyRequest	build() Returns an instance of a PolicyRequest which was constructed using this builder.
T	withProductType(java.lang.String productType) Sets the product type in the request.
T	withRequestTime(java.time.ZonedDateTime requestTime) Sets the request time in the request.
T	withRequestType(S requestType) Sets the request type in the request.
T	withSessionId(java.lang.String sessionId) Sets the session id in the Policy Request.
T	withUserIdentity(java.lang.String userIdentity) Sets the user identity in the request .This is a mandatory filed

Method Detail

withSessionId

T withSessionId(java.lang.String sessionId)

Sets the session id in the Policy Request. This is a mandatory field.

This is a unique identifier associated throughout the life of a ongoing Sy session

Parameters:

sessionId - unique identifier associated with the request (eg. SESSION-001)

Returns:

the current builder to support chaining construct.

withUserIdentity

T withUserIdentity(java.lang.String userIdentity)

Sets the user identity in the request .This is a mandatory filed

Equivalent diameter AVP : Subscription-Id -> Subscription-Id-Data or Public-Identity

Parameters:

userIdentity - user identity for the user (eg. 14081234567)

Returns:

the current builder to support chaining construct.

withProductType

T withProductType(java.lang.String productType)

Sets the product type in the request. This is an optional field

Equivalent diameter AVP : Service-Indication

Parameters:

productType - type of the product (eg. VOICE, DATA)

Returns:

the current builder to support chaining construct.

withRequestTime

T withRequestTime(java.time.ZonedDateTime requestTime)

Sets the request time in the request. This is a mandatory field

Parameters:

requestTime - request time (eg. 2013-11-01T00:01:00)

Returns:

the current builder to support chaining construct.

withRequestType

T withRequestType(S requestType)

Sets the request type in the request. This is a mandatory field

Equivalent diameter AVP : Subs-Req-Type

Parameters:

requestType - request type (eg. INITIAL)

Returns:

the current builder to support chaining construct.

build

PolicyRequest build()
             throws MessagesPolicyException

Returns an instance of a PolicyRequest which was constructed using this builder.

Returns:

an instance of a PolicyRequest created using the builder

Throws:

MessagesPolicyException - MessagesPolicyException