Package de.hybris.platform.tuawebservicesresources.v2.dto

Class ConsumptionSummary

java.lang.Object
de.hybris.platform.tuawebservicesresources.v2.dto.ConsumptionSummary
@Validated @Generated(value="de.hybris.platform.tuawebservicesresources.swagger.TmaCodegen", date="2022-10-21T20:35:04.698Z") public class ConsumptionSummary extends Object
The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket.

  • Constructor Details

    • ConsumptionSummary

      public ConsumptionSummary()

  • Method Details

    • counterType

      public ConsumptionSummary counterType(String counterType)

    • getCounterType

      public String getCounterType()
      Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example)
      Returns:
      counterType

    • setCounterType

      public void setCounterType(String counterType)

    • level

      public ConsumptionSummary level(String level)

    • getLevel

      public String getLevel()
      Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket
      Returns:
      level

    • setLevel

      public void setLevel(String level)

    • valueName

      public ConsumptionSummary valueName(String valueName)

    • getValueName

      public String getValueName()
      Value of the counter in a formatted string used for display needs for example
      Returns:
      valueName

    • setValueName

      public void setValueName(String valueName)

    • consumptionPeriod

      public ConsumptionSummary consumptionPeriod(TimePeriod consumptionPeriod)

    • getConsumptionPeriod

      @Valid public @Valid TimePeriod getConsumptionPeriod()
      Consumption counter period between a start date time and an end date time. For prepaid bucket, the period of counters is between the start date of the bucket and the effective date of the usage consumption report generation. For postpaid bucket, the period of counters is between the last bill date and the effective date of the usage consumption report generation.
      Returns:
      consumptionPeriod

    • setConsumptionPeriod

      public void setConsumptionPeriod(TimePeriod consumptionPeriod)

    • product

      public ConsumptionSummary product(NetworkProductRef product)

    • getProduct

      @Valid public @Valid NetworkProductRef getProduct()
      Public identifier associated to the product for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the network products), the list of them is not specified. It can be found through the network products listed in the bucket sub-resource
      Returns:
      product

    • setProduct

      public void setProduct(NetworkProductRef product)

    • user

      public ConsumptionSummary user(RelatedParty user)

    • getUser

      @Valid public @Valid RelatedParty getUser()
      Reference of the user for which the consumption counter is detailed. If the level of the counter is global (i.e. concerning all the users), the list of them is not specified. It can be found through the users listed in the network products of the bucket sub-resource
      Returns:
      user

    • setUser

      public void setUser(RelatedParty user)

    • value

      public ConsumptionSummary value(Quantity value)

    • getValue

      @Valid public @Valid Quantity getValue()
      Numeric value of the bucket counter in a given unit
      Returns:
      value

    • setValue

      public void setValue(Quantity value)

    • atbaseType

      public ConsumptionSummary 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 ConsumptionSummary 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 ConsumptionSummary 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