java.lang.Object
de.hybris.platform.usageconsumptiontmfwebservices.v1.dto.UsageVolumeBalance

@Validated @Generated(value="de.hybris.platform.usageconsumptiontmfwebservices.swagger.UsageConsumptionCodegen", date="2022-10-21T20:35:49.227Z") public class UsageVolumeBalance extends Object
The balance (called UsageVolumeBalance in the SID model) defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It corresponds to the initial allowed usage quantity minus the usage consumed on the bucket.
  • Constructor Details

    • UsageVolumeBalance

      public UsageVolumeBalance()
  • Method Details

    • remainingValueName

      public UsageVolumeBalance remainingValueName(String remainingValueName)
    • getRemainingValueName

      public String getRemainingValueName()
      Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example
      Returns:
      remainingValueName
    • setRemainingValueName

      public void setRemainingValueName(String remainingValueName)
    • remainingValue

      public UsageVolumeBalance remainingValue(Quantity remainingValue)
    • getRemainingValue

      @Valid public @Valid Quantity getRemainingValue()
      Numeric remaining value for the bucket given in the unit (for example 1.9). This numeric value could be used for calculation for example
      Returns:
      remainingValue
    • setRemainingValue

      public void setRemainingValue(Quantity remainingValue)
    • validFor

      public UsageVolumeBalance validFor(TimePeriod validFor)
    • getValidFor

      @Valid public @Valid TimePeriod getValidFor()
      Balance period between a start date time and an end date time. For prepaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the end date of the bucket. For postpaid bucket, the period of the balance is between the effective date of the usage consumption report generation and the next bill date.
      Returns:
      validFor
    • setValidFor

      public void setValidFor(TimePeriod validFor)
    • atbaseType

      public UsageVolumeBalance atbaseType(String atbaseType)
    • getAtbaseType

      public String getAtbaseType()
      When sub-classing, this defines the super-class
      Returns:
      atbaseType
    • setAtbaseType

      public void setAtbaseType(String atbaseType)
    • atschemaLocation

      public UsageVolumeBalance atschemaLocation(String atschemaLocation)
    • getAtschemaLocation

      public String getAtschemaLocation()
      A URI to a JSON-Schema file that defines additional attributes and relationships
      Returns:
      atschemaLocation
    • setAtschemaLocation

      public void setAtschemaLocation(String atschemaLocation)
    • attype

      public UsageVolumeBalance attype(String attype)
    • getAttype

      public String getAttype()
      When sub-classing, this defines the sub-class entity name
      Returns:
      attype
    • setAttype

      public void setAttype(String attype)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object