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 TypeMethodDescriptionbuild()
Returns an instance of a PolicyRequest which was constructed using this builder.withProductType
(String productType) Sets the product type in the request.withRequestTime
(ZonedDateTime requestTime) Sets the request time in the request.withRequestType
(S requestType) Sets the request type in the request.withSessionId
(String sessionId) Sets the session id in the Policy Request.withUserIdentity
(String userIdentity) Sets the user identity in the request .This is a mandatory filed
-
Method Details
-
withSessionId
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
Sets the user identity in the request .This is a mandatory filedEquivalent 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
Sets the product type in the request. This is an optional fieldEquivalent diameter AVP : Service-Indication
- Parameters:
productType
- type of the product (eg. VOICE, DATA)- Returns:
- the current builder to support chaining construct.
-
withRequestTime
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
Sets the request type in the request. This is a mandatory fieldEquivalent diameter AVP : Subs-Req-Type
- Parameters:
requestType
- request type (eg. INITIAL)- Returns:
- the current builder to support chaining construct.
-
build
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
-