Package oracle.communication.brm.charging.config.servicespec

Interface PayloadSpecBuilder

public interface PayloadSpecBuilder
Builds a payload spec

  • Method Details

    • withDefaultBeginMode

      PayloadSpecBuilder withDefaultBeginMode(PayloadSpecBuilder.BeginMode beginMode)
      Whether to use re-use of replace existing PayloadItem
      Parameters:
      beginMode - One of USE_EXISTING or REPLACE_EXISTING
      Returns:
      this PayloadSpecBuilder

    • withOperationTypes

      PayloadSpecBuilder withOperationTypes(String... ops)
      The Operation types to associate with the Payload spec to be built
      Parameters:
      ops -
      Returns:

    • withAction

      PayloadSpecBuilder withAction(String action)
      Currently one of "INPUT" or "OUTPUT" If "INPUT", the Pricing Updater uses this Payload spec to be part of a RequestSpecification
      Parameters:
      action -
      Returns:

    • beginRootBlockSpec

      PayloadSpecBuilder beginRootBlockSpec()
      Creates a root block
      Returns:

    • beginBlockSpec

      PayloadSpecBuilder beginBlockSpec(String name)
      Creates a block of name name
      Parameters:
      name -
      Returns:

    • withCardinality

      PayloadSpecBuilder withCardinality(String cardinality)
      Sets the cardinality of the PayloadItem
      Parameters:
      cardinality -
      Returns:

    • withNetworkField

      PayloadSpecBuilder withNetworkField(String networkField)
      Sets the name of the associated network field in the network spec
      Parameters:
      networkField -
      Returns:

    • withNetworkField5g

      PayloadSpecBuilder withNetworkField5g(String networkField5g)
      Sets the name of the associated network field in the network spec
      Parameters:
      networkField5g -
      Returns:

    • withPersistenceField

      PayloadSpecBuilder withPersistenceField(String persistenceField)
      Sets the name of the associated database field in BRM
      Parameters:
      persistenceField -
      Returns:

    • withPersistenceField5g

      PayloadSpecBuilder withPersistenceField5g(String persistenceField5g)
      Sets the name of the associated database field in BRM
      Parameters:
      persistenceField5g -
      Returns:

    • withPrimaryPersistenceField

      PayloadSpecBuilder withPrimaryPersistenceField(boolean isPrimaryPersistenceField)
      Sets the primary persistence field indicator.
      Parameters:
      isPrimaryPersistenceField - {true}, if the field is a persistence field is primary or not
      Returns:

    • withDefaultValue

      PayloadSpecBuilder withDefaultValue(String value)
      Sets a default value for this PayloadItem
      Parameters:
      value -
      Returns:

    • beginFieldSpec

      PayloadSpecBuilder beginFieldSpec(String name, oracle.communication.brm.charging.config.attributespec.AttributeSpecTypes type) throws oracle.communication.brm.charging.config.ConfigException
      Creates a new field
      Parameters:
      name - Name of the field
      type - Payload type of the field
      Returns:
      this PayloadSpecBuilder
      Throws:
      oracle.communication.brm.charging.config.ConfigException

    • endFieldSpec

      PayloadSpecBuilder endFieldSpec()
      Indicates that the creation of field in payload spec has ended
      Returns:

    • endBlockSpec

      PayloadSpecBuilder endBlockSpec()
      Indicates that the creation of block in payload spec has ended
      Returns:

    • endRootBlockSpec

      PayloadSpecBuilder endRootBlockSpec()
      Indicates that the creation of the root block in payload spec has ended
      Returns:

    • build

      PayloadSpec build()
      Build and return the payload spec
      Returns: