Interface PayloadAttributeInfo


public interface PayloadAttributeInfo
This class is used to present Meta data associated with a PayloadAttribute that resided inside the PayloadBlock.
  • Method Summary

    Modifier and Type
    Method
    Description
    <T> String
    convert(T value)
    Translates an object value to a string value
    gets the cardinality for this payload item
    accessor gets the name of the attribute
    method returns the network field from which this PayloadItem is populated.
    method returns the network field from which this PayloadItem is populated.
    Returns the table or column name associated with this block
    Returns the table or column name associated with this block
    Method used to get the Type of the PayloadItem.
    <T> T
    Method return the current value on the PayloadItem.
    boolean
    method checks if this PayloadItem is optional or mandatory within the Payload.
    boolean
    Returns the indicator for primary or non-primary persistence field
    <T> T
    Translates a string value to an object value Used in pricing updater to convert a default value received in String format from BCC/Pdc to an object value compatible with the appropriate subclass of PayloadItem Only applicable for fields, not blocks
  • Method Details

    • getName

      String getName()
      accessor gets the name of the attribute
      Returns:
      name of the attribute
    • getType

      Class getType()
      Method used to get the Type of the PayloadItem.
      Returns:
      the type of the PayloadItem value. Will return null if the type cannot be acquired.
    • getValue

      <T> T getValue()
      Method return the current value on the PayloadItem. Can be used to obtain the default value from the PayloadSpec.
      Type Parameters:
      T - the expected type of the PayloadItem
      Returns:
      the current value on the PayloadItem
    • getCardinality

      PayloadItemCardinality getCardinality()
      gets the cardinality for this payload item
      Returns:
      the cardinality for this payload item
    • isOptional

      boolean isOptional()
      method checks if this PayloadItem is optional or mandatory within the Payload.
      Returns:
      true if the PayloadItem has optional cardinality. (ie. [0..1] or [0..*] )
    • getNetworkField

      String getNetworkField()
      method returns the network field from which this PayloadItem is populated.
      Returns:
      the network field from which this PayloadItem is populated.
    • getNetworkField5g

      String getNetworkField5g()
      method returns the network field from which this PayloadItem is populated.
      Returns:
      the network field from which this PayloadItem is populated.
    • getPersistenceField

      String getPersistenceField()
      Returns the table or column name associated with this block
      Returns:
      Table name
    • getPersistenceField5g

      String getPersistenceField5g()
      Returns the table or column name associated with this block
      Returns:
      Table name
    • isPrimaryPersistenceField

      boolean isPrimaryPersistenceField()
      Returns the indicator for primary or non-primary persistence field
      Returns:
      {true}, if the field is a persistence field is primary or not
    • translateValue

      <T> T translateValue(String value)
      Translates a string value to an object value Used in pricing updater to convert a default value received in String format from BCC/Pdc to an object value compatible with the appropriate subclass of PayloadItem Only applicable for fields, not blocks
      Type Parameters:
      T -
      Parameters:
      value -
      Returns:
    • convert

      <T> String convert(T value)
      Translates an object value to a string value
      Type Parameters:
      T -
      Parameters:
      value -
      Returns: