oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class RetailPlannedImpactType

java.lang.Object

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

public class RetailPlannedImpactType
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AmountType	amount
protected ForecastPurposeCodeType	forecastPurposeCode
protected ForecastTypeCodeType	forecastTypeCode
protected PeriodType	period

Constructor Summary

Constructors

Constructor and Description
RetailPlannedImpactType()

Method Summary

Modifier and Type	Method and Description
AmountType	getAmount() <?
ForecastPurposeCodeType	getForecastPurposeCode() <?
ForecastTypeCodeType	getForecastTypeCode() <?
PeriodType	getPeriod() <?
void	setAmount(AmountType value) Sets the value of the amount property.
void	setForecastPurposeCode(ForecastPurposeCodeType value) Sets the value of the forecastPurposeCode property.
void	setForecastTypeCode(ForecastTypeCodeType value) Sets the value of the forecastTypeCode property.
void	setPeriod(PeriodType value) Sets the value of the period property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

amount

protected AmountType amount

forecastPurposeCode

protected ForecastPurposeCodeType forecastPurposeCode

forecastTypeCode

protected ForecastTypeCodeType forecastTypeCode

period

protected PeriodType period

Constructor Detail

RetailPlannedImpactType

public RetailPlannedImpactType()

Method Detail

getAmount

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

Sets the value of the amount property.

Parameters:

value - allowed object is AmountType

getForecastPurposeCode

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

Sets the value of the forecastPurposeCode property.

Parameters:

value - allowed object is ForecastPurposeCodeType

getForecastTypeCode

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

Sets the value of the forecastTypeCode property.

Parameters:

value - allowed object is ForecastTypeCodeType

getPeriod

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

Sets the value of the period property.

Parameters:

value - allowed object is PeriodType