oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21

Class RetailPlannedImpactType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.RetailPlannedImpactType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class RetailPlannedImpactType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

 <?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: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>
 

Java class for RetailPlannedImpactType complex type.

The following schema fragment specifies the expected content contained within this class.

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

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

Method Summary

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 this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
AmountType	getAmount() <?
BigDecimal	getAmountValue() Get the value of the contained AmountType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ForecastPurposeCodeType	getForecastPurposeCode() <?
String	getForecastPurposeCodeValue() Get the value of the contained ForecastPurposeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
ForecastTypeCodeType	getForecastTypeCode() <?
String	getForecastTypeCodeValue() Get the value of the contained ForecastTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
PeriodType	getPeriod() <?
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 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 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 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()

 <?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: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>
 

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()

 <?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: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>
 

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()

 <?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: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>
 

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()

 <?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: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>
 

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 this 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 null.

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 null.

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 null.

Returns:

The created intermediary object of type AmountType and never null

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 null.

Returns:

The created intermediary object of type ForecastPurposeCodeType and never null

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 null.

Returns:

The created intermediary object of type ForecastTypeCodeType and never null

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 null

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 null

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 null