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

Class EventLineItemType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class EventLineItemType
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>Event Line Item. Details</ccts:DictionaryEntryName><ccts:Definition>A class to define a line item describing the expected impacts associated with a retail event involving a specific product at a specific location.</ccts:Definition><ccts:ObjectClass>Event Line Item</ccts:ObjectClass></ccts:Component>
 

Java class for EventLineItemType complex type.

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

 <complexType name="EventLineItemType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LineNumberNumeric" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ParticipatingLocationsLocation" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}RetailPlannedImpact" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SupplyItem"/>
       </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-list-extension

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
EventLineItemType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addRetailPlannedImpact(RetailPlannedImpactType elem) Created by ph-jaxb22-plugin -Xph-list-extension
EventLineItemType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(EventLineItemType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
LineNumberNumericType	getLineNumberNumeric() <?
BigDecimal	getLineNumberNumericValue() Get the value of the contained LineNumberNumericType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
LocationType	getParticipatingLocationsLocation() <?
List<RetailPlannedImpactType>	getRetailPlannedImpact() <?
RetailPlannedImpactType	getRetailPlannedImpactAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getRetailPlannedImpactCount() Created by ph-jaxb22-plugin -Xph-list-extension
ItemType	getSupplyItem() <?
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoRetailPlannedImpactEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasRetailPlannedImpactEntries() Created by ph-jaxb22-plugin -Xph-list-extension
LineNumberNumericType	setLineNumberNumeric(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setLineNumberNumeric(LineNumberNumericType value) Sets the value of the lineNumberNumeric property.
void	setParticipatingLocationsLocation(LocationType value) Sets the value of the participatingLocationsLocation property.
void	setRetailPlannedImpact(List<RetailPlannedImpactType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setSupplyItem(ItemType value) Sets the value of the supplyItem 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

EventLineItemType

public EventLineItemType()

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

Method Detail

getLineNumberNumeric

@Nullable
public LineNumberNumericType getLineNumberNumeric()

 <?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>Event Line Item. Line Number. Numeric</ccts:DictionaryEntryName><ccts:Definition>The number of this event line item.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Event Line Item</ccts:ObjectClass><ccts:PropertyTerm>Line Number</ccts:PropertyTerm><ccts:RepresentationTerm>Numeric</ccts:RepresentationTerm><ccts:DataType>Numeric. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is LineNumberNumericType

setLineNumberNumeric

public void setLineNumberNumeric(@Nullable
                                 LineNumberNumericType value)

Sets the value of the lineNumberNumeric property.

Parameters:

value - allowed object is LineNumberNumericType

getParticipatingLocationsLocation

@Nullable
public LocationType getParticipatingLocationsLocation()

 <?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>Event Line Item. Participating Locations_ Location. Location</ccts:DictionaryEntryName><ccts:Definition>The location of the stores involved in the event described in this line item.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Event Line Item</ccts:ObjectClass><ccts:PropertyTermQualifier>Participating Locations</ccts:PropertyTermQualifier><ccts:PropertyTerm>Location</ccts:PropertyTerm><ccts:AssociatedObjectClass>Location</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Location</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is LocationType

setParticipatingLocationsLocation

public void setParticipatingLocationsLocation(@Nullable
                                              LocationType value)

Sets the value of the participatingLocationsLocation property.

Parameters:

value - allowed object is LocationType

getRetailPlannedImpact

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<RetailPlannedImpactType> getRetailPlannedImpact()

 <?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>Event Line Item. Retail Planned Impact</ccts:DictionaryEntryName><ccts:Definition>A planned impact of the event described in this line item.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Event Line Item</ccts:ObjectClass><ccts:PropertyTerm>Retail Planned Impact</ccts:PropertyTerm><ccts:AssociatedObjectClass>Retail Planned Impact</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Retail Planned Impact</ccts:RepresentationTerm></ccts:Component>
 

Gets the value of the retailPlannedImpact property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the retailPlannedImpact property.

For example, to add a new item, do as follows:

    getRetailPlannedImpact().add(newItem);
 

Objects of the following type(s) are allowed in the list RetailPlannedImpactType

getSupplyItem

@Nullable
public ItemType getSupplyItem()

 <?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>Event Line Item. Supply_ Item. Item</ccts:DictionaryEntryName><ccts:Definition>The product with which the event is associated.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Event Line Item</ccts:ObjectClass><ccts:PropertyTermQualifier>Supply</ccts:PropertyTermQualifier><ccts:PropertyTerm>Item</ccts:PropertyTerm><ccts:AssociatedObjectClass>Item</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Item</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is ItemType

setSupplyItem

public void setSupplyItem(@Nullable
                          ItemType value)

Sets the value of the supplyItem property.

Parameters:

value - allowed object is ItemType

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

setRetailPlannedImpact

public void setRetailPlannedImpact(@Nullable
                                   List<RetailPlannedImpactType> aList)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

hasRetailPlannedImpactEntries

public boolean hasRetailPlannedImpactEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoRetailPlannedImpactEntries

public boolean hasNoRetailPlannedImpactEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getRetailPlannedImpactCount

@Nonnegative
public int getRetailPlannedImpactCount()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getRetailPlannedImpactAtIndex

@Nullable
public RetailPlannedImpactType getRetailPlannedImpactAtIndex(@Nonnegative
                                                                        int index)
                                                                 throws IndexOutOfBoundsException

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

index - The index to retrieve

Returns:

The element at the specified index. May be null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addRetailPlannedImpact

public void addRetailPlannedImpact(@Nonnull
                                   RetailPlannedImpactType elem)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

cloneTo

public void cloneTo(@Nonnull
                    EventLineItemType 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 EventLineItemType 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.

setLineNumberNumeric

@Nonnull
public LineNumberNumericType setLineNumberNumeric(@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 LineNumberNumericType and never null

getLineNumberNumericValue

@Nullable
public BigDecimal getLineNumberNumericValue()

Get the value of the contained LineNumberNumericType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained LineNumberNumericType object or null