RetailPlannedImpactType (ph-ubl22 6.7.0 API)

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

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class RetailPlannedImpactType
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>Retail Planned Impact. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a planned effect of a retail event (e.g., a promotion or a change in inventory policy) upon supply or demand.</ccts:Definition><ccts:ObjectClass>Retail Planned Impact</ccts:ObjectClass></ccts:Component> </pre> Java class for RetailPlannedImpactType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="RetailPlannedImpactType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Amount"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ForecastPurposeCode"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ForecastTypeCode"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Period" minOccurs="0"/> </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

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

Constructors
Constructor and Description
`RetailPlannedImpactType()` 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
`RetailPlannedImpactType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(RetailPlannedImpactType 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
`AmountType`	`getAmount()` <pre> <?
`BigDecimal`	`getAmountValue()` Get the value of the contained AmountType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`ForecastPurposeCodeType`	`getForecastPurposeCode()` <pre> <?
`String`	`getForecastPurposeCodeValue()` Get the value of the contained ForecastPurposeCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`ForecastTypeCodeType`	`getForecastTypeCode()` <pre> <?
`String`	`getForecastTypeCodeValue()` Get the value of the contained ForecastTypeCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`PeriodType`	`getPeriod()` <pre> <?
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`void`	`setAmount(AmountType value)` Sets the value of the amount property.
`AmountType`	`setAmount(BigDecimal valueParam)` Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setForecastPurposeCode(ForecastPurposeCodeType value)` Sets the value of the forecastPurposeCode property.
`ForecastPurposeCodeType`	`setForecastPurposeCode(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setForecastTypeCode(ForecastTypeCodeType value)` Sets the value of the forecastTypeCode property.
`ForecastTypeCodeType`	`setForecastTypeCode(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.
`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
 - RetailPlannedImpactType
```
public RetailPlannedImpactType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getAmount
```
@Nullable
public AmountType getAmount()
```
 <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>Retail Planned Impact. Amount</ccts:DictionaryEntryName><ccts:Definition>Estimated monetary value of the planned event as an impact</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Retail Planned Impact</ccts:ObjectClass><ccts:PropertyTerm>Amount</ccts:PropertyTerm><ccts:RepresentationTerm>Amount</ccts:RepresentationTerm><ccts:DataType>Amount. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is AmountType
 - setAmount
```
public void setAmount(@Nullable
 AmountType value)
```
 Sets the value of the amount property.
 
 Parameters:
 
 value - allowed object is AmountType
 - getForecastPurposeCode
```
@Nullable
public ForecastPurposeCodeType getForecastPurposeCode()
```
 <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>Retail Planned Impact. Forecast_ Purpose Code. Code</ccts:DictionaryEntryName><ccts:Definition>It will have impact on either Sales forecast or Order Forecast</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Retail Planned Impact</ccts:ObjectClass><ccts:PropertyTermQualifier>Forecast</ccts:PropertyTermQualifier><ccts:PropertyTerm>Purpose Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is ForecastPurposeCodeType
 - setForecastPurposeCode
```
public void setForecastPurposeCode(@Nullable
 ForecastPurposeCodeType value)
```
 Sets the value of the forecastPurposeCode property.
 
 Parameters:
 
 value - allowed object is ForecastPurposeCodeType
 - getForecastTypeCode
```
@Nullable
public ForecastTypeCodeType getForecastTypeCode()
```
 <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>Retail Planned Impact. Forecast Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the type of forecast. Examples of values are: BASE PROMOTIONAL SEASONAL TOTAL</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Retail Planned Impact</ccts:ObjectClass><ccts:PropertyTerm>Forecast Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is ForecastTypeCodeType
 - setForecastTypeCode
```
public void setForecastTypeCode(@Nullable
 ForecastTypeCodeType value)
```
 Sets the value of the forecastTypeCode property.
 
 Parameters:
 
 value - allowed object is ForecastTypeCodeType
 - 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>Retail Planned Impact. Period</ccts:DictionaryEntryName><ccts:Definition>The period to which this impact applies.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Retail Planned Impact</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
 RetailPlannedImpactType 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 RetailPlannedImpactType 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>.
 - setAmount
```
@Nonnull
public AmountType setAmount(@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 AmountType and never <code>null</code>
 - setForecastPurposeCode
```
@Nonnull
public ForecastPurposeCodeType setForecastPurposeCode(@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 ForecastPurposeCodeType and never <code>null</code>
 - setForecastTypeCode
```
@Nonnull
public ForecastTypeCodeType setForecastTypeCode(@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 ForecastTypeCodeType and never <code>null</code>
 - getAmountValue
```
@Nullable
public BigDecimal getAmountValue()
```
 Get the value of the contained AmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained AmountType object or <code>null</code>
 - getForecastPurposeCodeValue
```
@Nullable
public String getForecastPurposeCodeValue()
```
 Get the value of the contained ForecastPurposeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained ForecastPurposeCodeType object or <code>null</code>
 - getForecastTypeCodeValue
```
@Nullable
public String getForecastTypeCodeValue()
```
 Get the value of the contained ForecastTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained ForecastTypeCodeType object or <code>null</code>

Class RetailPlannedImpactType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RetailPlannedImpactType

Method Detail

getAmount

setAmount

getForecastPurposeCode

setForecastPurposeCode

getForecastTypeCode

setForecastTypeCode

getPeriod

setPeriod

equals

hashCode

toString

cloneTo

clone

setAmount

setForecastPurposeCode

setForecastTypeCode

getAmountValue

getForecastPurposeCodeValue

getForecastTypeCodeValue