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

Class SalesItemType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class SalesItemType
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>Sales Item. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe information related to an item in a sales context</ccts:Definition><ccts:ObjectClass>Sales Item</ccts:ObjectClass></ccts:Component>
 

Java class for SalesItemType complex type.

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

 <complexType name="SalesItemType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Quantity"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ActivityProperty" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TaxExclusivePrice" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TaxInclusivePrice" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Item"/>
       </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
SalesItemType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addActivityProperty(ActivityPropertyType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addTaxExclusivePrice(PriceType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addTaxInclusivePrice(PriceType elem) Created by ph-jaxb22-plugin -Xph-list-extension
SalesItemType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(SalesItemType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<ActivityPropertyType>	getActivityProperty() <?
ActivityPropertyType	getActivityPropertyAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getActivityPropertyCount() Created by ph-jaxb22-plugin -Xph-list-extension
ItemType	getItem() <?
QuantityType	getQuantity() <?
BigDecimal	getQuantityValue() Get the value of the contained QuantityType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<PriceType>	getTaxExclusivePrice() <?
PriceType	getTaxExclusivePriceAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getTaxExclusivePriceCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<PriceType>	getTaxInclusivePrice() <?
PriceType	getTaxInclusivePriceAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getTaxInclusivePriceCount() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasActivityPropertyEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoActivityPropertyEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoTaxExclusivePriceEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoTaxInclusivePriceEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasTaxExclusivePriceEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasTaxInclusivePriceEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setActivityProperty(List<ActivityPropertyType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setItem(ItemType value) Sets the value of the item property.
QuantityType	setQuantity(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setQuantity(QuantityType value) Sets the value of the quantity property.
void	setTaxExclusivePrice(List<PriceType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setTaxInclusivePrice(List<PriceType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
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

SalesItemType

public SalesItemType()

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

Method Detail

getQuantity

@Nullable
public QuantityType getQuantity()

 <?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>Sales Item. Quantity</ccts:DictionaryEntryName><ccts:Definition>The quantity the given information are related to</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Sales Item</ccts:ObjectClass><ccts:PropertyTerm>Quantity</ccts:PropertyTerm><ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm><ccts:DataType>Quantity. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is QuantityType

setQuantity

public void setQuantity(@Nullable
                        QuantityType value)

Sets the value of the quantity property.

Parameters:

value - allowed object is QuantityType

getActivityProperty

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<ActivityPropertyType> getActivityProperty()

 <?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>Sales Item. Activity Property</ccts:DictionaryEntryName><ccts:Definition>A class to describe the activity (for example "sales", "movement", ...) related to the item.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Sales Item</ccts:ObjectClass><ccts:PropertyTerm>Activity Property</ccts:PropertyTerm><ccts:AssociatedObjectClass>Activity Property</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Activity Property</ccts:RepresentationTerm></ccts:Component>
 

Gets the value of the activityProperty 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 activityProperty property.

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

    getActivityProperty().add(newItem);
 

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

getTaxExclusivePrice

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<PriceType> getTaxExclusivePrice()

 <?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>Sales Item. Tax Exclusive_ Price. Price</ccts:DictionaryEntryName><ccts:Definition>A price for this sales item, exclusive of tax.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Sales Item</ccts:ObjectClass><ccts:PropertyTermQualifier>Tax Exclusive</ccts:PropertyTermQualifier><ccts:PropertyTerm>Price</ccts:PropertyTerm><ccts:AssociatedObjectClass>Price</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Price</ccts:RepresentationTerm></ccts:Component>
 

Gets the value of the taxExclusivePrice 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 taxExclusivePrice property.

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

    getTaxExclusivePrice().add(newItem);
 

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

getTaxInclusivePrice

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<PriceType> getTaxInclusivePrice()

 <?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>Sales Item. Tax Inclusive_ Price. Price</ccts:DictionaryEntryName><ccts:Definition>A price for this sales item, including tax.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Sales Item</ccts:ObjectClass><ccts:PropertyTermQualifier>Tax Inclusive</ccts:PropertyTermQualifier><ccts:PropertyTerm>Price</ccts:PropertyTerm><ccts:AssociatedObjectClass>Price</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Price</ccts:RepresentationTerm></ccts:Component>
 

Gets the value of the taxInclusivePrice 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 taxInclusivePrice property.

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

    getTaxInclusivePrice().add(newItem);
 

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

getItem

@Nullable
public ItemType getItem()

 <?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>Sales Item. Item</ccts:DictionaryEntryName><ccts:Definition>The sales item itself.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Sales Item</ccts:ObjectClass><ccts:PropertyTerm>Item</ccts:PropertyTerm><ccts:AssociatedObjectClass>Item</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Item</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is ItemType

setItem

public void setItem(@Nullable
                    ItemType value)

Sets the value of the item 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

setActivityProperty

public void setActivityProperty(@Nullable
                                List<ActivityPropertyType> aList)

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

Parameters:

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

setTaxExclusivePrice

public void setTaxExclusivePrice(@Nullable
                                 List<PriceType> aList)

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

Parameters:

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

setTaxInclusivePrice

public void setTaxInclusivePrice(@Nullable
                                 List<PriceType> aList)

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

Parameters:

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

hasActivityPropertyEntries

public boolean hasActivityPropertyEntries()

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

Returns:

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

hasNoActivityPropertyEntries

public boolean hasNoActivityPropertyEntries()

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

Returns:

true if no item is contained, false otherwise.

getActivityPropertyCount

@Nonnegative
public int getActivityPropertyCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getActivityPropertyAtIndex

@Nullable
public ActivityPropertyType getActivityPropertyAtIndex(@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!

addActivityProperty

public void addActivityProperty(@Nonnull
                                ActivityPropertyType elem)

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

Parameters:

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

hasTaxExclusivePriceEntries

public boolean hasTaxExclusivePriceEntries()

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

Returns:

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

hasNoTaxExclusivePriceEntries

public boolean hasNoTaxExclusivePriceEntries()

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

Returns:

true if no item is contained, false otherwise.

getTaxExclusivePriceCount

@Nonnegative
public int getTaxExclusivePriceCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getTaxExclusivePriceAtIndex

@Nullable
public PriceType getTaxExclusivePriceAtIndex(@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!

addTaxExclusivePrice

public void addTaxExclusivePrice(@Nonnull
                                 PriceType elem)

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

Parameters:

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

hasTaxInclusivePriceEntries

public boolean hasTaxInclusivePriceEntries()

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

Returns:

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

hasNoTaxInclusivePriceEntries

public boolean hasNoTaxInclusivePriceEntries()

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

Returns:

true if no item is contained, false otherwise.

getTaxInclusivePriceCount

@Nonnegative
public int getTaxInclusivePriceCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getTaxInclusivePriceAtIndex

@Nullable
public PriceType getTaxInclusivePriceAtIndex(@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!

addTaxInclusivePrice

public void addTaxInclusivePrice(@Nonnull
                                 PriceType 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
                    SalesItemType 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 SalesItemType 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.

setQuantity

@Nonnull
public QuantityType setQuantity(@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 QuantityType and never null

getQuantityValue

@Nullable
public BigDecimal getQuantityValue()

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

Returns:

Either the value of the contained QuantityType object or null