ConsumptionReportReferenceType (ph-ubl22 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_22.ConsumptionReportReferenceType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class ConsumptionReportReferenceType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
<pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Consumption Report Reference. Details</ccts:DictionaryEntryName><ccts:Definition>A class to define a reference to an earlier consumption report (e.g., last year's consumption).</ccts:Definition><ccts:ObjectClass>Consumption Report Reference</ccts:ObjectClass></ccts:Component> </pre> Java class for ConsumptionReportReferenceType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="ConsumptionReportReferenceType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumptionReportID"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumptionType" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ConsumptionTypeCode" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TotalConsumedQuantity"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Period"/> </sequence> </restriction> </complexContent> </complexType> </pre> This class was annotated by ph-jaxb22-plugin -Xph-annotate This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode This class contains methods created by ph-jaxb22-plugin -Xph-tostring This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2 This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConsumptionReportReferenceType()
Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Constructors
Constructor and Description
`ConsumptionReportReferenceType()` Default constructor<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConsumptionReportReferenceType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(ConsumptionReportReferenceType ret)` This method clones all values from <code>this</code> to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`ConsumptionReportIDType`	`getConsumptionReportID()` <pre> <?
`String`	`getConsumptionReportIDValue()` Get the value of the contained ConsumptionReportIDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`ConsumptionTypeType`	`getConsumptionType()` <pre> <?
`ConsumptionTypeCodeType`	`getConsumptionTypeCode()` <pre> <?
`String`	`getConsumptionTypeCodeValue()` Get the value of the contained ConsumptionTypeCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`String`	`getConsumptionTypeValue()` Get the value of the contained ConsumptionTypeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`PeriodType`	`getPeriod()` <pre> <?
`TotalConsumedQuantityType`	`getTotalConsumedQuantity()` <pre> <?
`BigDecimal`	`getTotalConsumedQuantityValue()` Get the value of the contained TotalConsumedQuantityType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`void`	`setConsumptionReportID(ConsumptionReportIDType value)` Sets the value of the consumptionReportID property.
`ConsumptionReportIDType`	`setConsumptionReportID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setConsumptionType(ConsumptionTypeType value)` Sets the value of the consumptionType property.
`ConsumptionTypeType`	`setConsumptionType(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setConsumptionTypeCode(ConsumptionTypeCodeType value)` Sets the value of the consumptionTypeCode property.
`ConsumptionTypeCodeType`	`setConsumptionTypeCode(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setPeriod(PeriodType value)` Sets the value of the period property.
`TotalConsumedQuantityType`	`setTotalConsumedQuantity(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setTotalConsumedQuantity(TotalConsumedQuantityType value)` Sets the value of the totalConsumedQuantity property.
`String`	`toString()` Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - ConsumptionReportReferenceType
```
public ConsumptionReportReferenceType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getConsumptionReportID
```
@Nullable
public ConsumptionReportIDType getConsumptionReportID()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Consumption Report Reference. Consumption_ Report Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for the referenced consumption report.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Consumption Report Reference</ccts:ObjectClass><ccts:PropertyTermQualifier>Consumption</ccts:PropertyTermQualifier><ccts:PropertyTerm>Report Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>n/a</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is ConsumptionReportIDType
 - setConsumptionReportID
```
public void setConsumptionReportID(@Nullable
 ConsumptionReportIDType value)
```
 Sets the value of the consumptionReportID property.
 
 Parameters:
 
 value - allowed object is ConsumptionReportIDType
 - getConsumptionType
```
@Nullable
public ConsumptionTypeType getConsumptionType()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Consumption Report Reference. Consumption Type. Text</ccts:DictionaryEntryName><ccts:Definition>The reported consumption type, expressed as text.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption Report Reference</ccts:ObjectClass><ccts:PropertyTerm>Consumption Type</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>Consumption</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is ConsumptionTypeType
 - setConsumptionType
```
public void setConsumptionType(@Nullable
 ConsumptionTypeType value)
```
 Sets the value of the consumptionType property.
 
 Parameters:
 
 value - allowed object is ConsumptionTypeType
 - getConsumptionTypeCode
```
@Nullable
public ConsumptionTypeCodeType getConsumptionTypeCode()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Consumption Report Reference. Consumption Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>The reported consumption type, expressed as a code.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Consumption Report Reference</ccts:ObjectClass><ccts:PropertyTerm>Consumption Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType><ccts:Examples>Consumption</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is ConsumptionTypeCodeType
 - setConsumptionTypeCode
```
public void setConsumptionTypeCode(@Nullable
 ConsumptionTypeCodeType value)
```
 Sets the value of the consumptionTypeCode property.
 
 Parameters:
 
 value - allowed object is ConsumptionTypeCodeType
 - getTotalConsumedQuantity
```
@Nullable
public TotalConsumedQuantityType getTotalConsumedQuantity()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Consumption Report Reference. Total_ Consumed Quantity. Quantity</ccts:DictionaryEntryName><ccts:Definition>The total quantity consumed during the period of the referenced report.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Consumption Report Reference</ccts:ObjectClass><ccts:PropertyTermQualifier>Total</ccts:PropertyTermQualifier><ccts:PropertyTerm>Consumed Quantity</ccts:PropertyTerm><ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm><ccts:DataType>Quantity. Type</ccts:DataType><ccts:Examples>20479.00</ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is TotalConsumedQuantityType
 - setTotalConsumedQuantity
```
public void setTotalConsumedQuantity(@Nullable
 TotalConsumedQuantityType value)
```
 Sets the value of the totalConsumedQuantity property.
 
 Parameters:
 
 value - allowed object is TotalConsumedQuantityType
 - getPeriod
```
@Nullable
public PeriodType getPeriod()
```
 <pre> <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Consumption Report Reference. Period</ccts:DictionaryEntryName><ccts:Definition>The period of consumption covered by the referenced report.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Consumption Report Reference</ccts:ObjectClass><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is PeriodType
 - setPeriod
```
public void setPeriod(@Nullable
 PeriodType value)
```
 Sets the value of the period property.
 
 Parameters:
 
 value - allowed object is PeriodType
 - equals
```
public boolean equals(Object o)
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 equals in class Object
 - hashCode
```
public int hashCode()
```
 Created by ph-jaxb22-plugin -Xph-equalshashcode
 
 Overrides:
 
 hashCode in class Object
 - toString
```
public String toString()
```
 Created by ph-jaxb22-plugin -Xph-tostring
 
 Overrides:
 
 toString in class Object
 - cloneTo
```
public void cloneTo(@Nonnull
 ConsumptionReportReferenceType ret)
```
 This method clones all values from <code>this</code> to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Parameters:
 
 ret - The target object to clone to. May not be <code>null</code>.
 - clone
```
@Nonnull
 @ReturnsMutableCopy
public ConsumptionReportReferenceType clone()
```
 Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Specified by:
 
 clone in interface com.helger.commons.lang.IExplicitlyCloneable
 
 Overrides:
 
 clone in class Object
 
 Returns:
 
 The cloned object. Never <code>null</code>.
 - setConsumptionTypeCode
```
@Nonnull
public ConsumptionTypeCodeType setConsumptionTypeCode(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type ConsumptionTypeCodeType and never <code>null</code>
 - setConsumptionReportID
```
@Nonnull
public ConsumptionReportIDType setConsumptionReportID(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type ConsumptionReportIDType and never <code>null</code>
 - setTotalConsumedQuantity
```
@Nonnull
public TotalConsumedQuantityType setTotalConsumedQuantity(@Nullable
 BigDecimal valueParam)
```
 Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type TotalConsumedQuantityType and never <code>null</code>
 - setConsumptionType
```
@Nonnull
public ConsumptionTypeType setConsumptionType(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type ConsumptionTypeType and never <code>null</code>
 - getConsumptionReportIDValue
```
@Nullable
public String getConsumptionReportIDValue()
```
 Get the value of the contained ConsumptionReportIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained ConsumptionReportIDType object or <code>null</code>
 - getConsumptionTypeValue
```
@Nullable
public String getConsumptionTypeValue()
```
 Get the value of the contained ConsumptionTypeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained ConsumptionTypeType object or <code>null</code>
 - getConsumptionTypeCodeValue
```
@Nullable
public String getConsumptionTypeCodeValue()
```
 Get the value of the contained ConsumptionTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained ConsumptionTypeCodeType object or <code>null</code>
 - getTotalConsumedQuantityValue
```
@Nullable
public BigDecimal getTotalConsumedQuantityValue()
```
 Get the value of the contained TotalConsumedQuantityType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained TotalConsumedQuantityType object or <code>null</code>

Class ConsumptionReportReferenceType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsumptionReportReferenceType

Method Detail

getConsumptionReportID

setConsumptionReportID

getConsumptionType

setConsumptionType

getConsumptionTypeCode

setConsumptionTypeCode

getTotalConsumedQuantity

setTotalConsumedQuantity

getPeriod

setPeriod

equals

hashCode

toString

cloneTo

clone

setConsumptionTypeCode

setConsumptionReportID

setTotalConsumedQuantity

setConsumptionType

getConsumptionReportIDValue

getConsumptionTypeValue

getConsumptionTypeCodeValue

getTotalConsumedQuantityValue