oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_23

Class PrizeType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_23.PrizeType

All Implemented Interfaces:

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

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

<p>Java class for PrizeType complex type. <p>The following schema fragment specifies the expected content contained within this class. <pre> &lt;complexType name="PrizeType"&gt; &lt;complexContent&gt; &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt; &lt;sequence&gt; &lt;element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2}UBLExtensions" minOccurs="0"/&gt; &lt;element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}RankCode"/&gt; &lt;element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ValueAmount" minOccurs="0"/&gt; &lt;element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Description" maxOccurs="unbounded" minOccurs="0"/&gt; &lt;/sequence&gt; &lt;/restriction&gt; &lt;/complexContent&gt; &lt;/complexType&gt; </pre> <p>This class was annotated by ph-jaxb22-plugin -Xph-annotate</p> <p>This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode</p> <p>This class contains methods created by ph-jaxb22-plugin -Xph-tostring</p> <p>This class contains methods created by ph-jaxb22-plugin -Xph-list-extension</p> <p>This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2</p> <p>This class contains methods created by ph-jaxb22-plugin -Xph-value-extender</p>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrizeType() Default constructor<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addDescription(DescriptionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
PrizeType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(PrizeType 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
List<DescriptionType>	getDescription() Gets the value of the description property.
DescriptionType	getDescriptionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getDescriptionCount() Created by ph-jaxb22-plugin -Xph-list-extension
RankCodeType	getRankCode() Gets the value of the rankCode property.
String	getRankCodeValue() Get the value of the contained RankCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
UBLExtensionsType	getUBLExtensions() Gets the value of the ublExtensions property.
ValueAmountType	getValueAmount() Gets the value of the valueAmount property.
BigDecimal	getValueAmountValue() Get the value of the contained ValueAmountType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
boolean	hasDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setDescription(List<DescriptionType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setRankCode(RankCodeType value) Sets the value of the rankCode property.
RankCodeType	setRankCode(String valueParam) Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setUBLExtensions(UBLExtensionsType value) Sets the value of the ublExtensions property.
ValueAmountType	setValueAmount(BigDecimal valueParam) Special setter with value of type BigDecimal<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setValueAmount(ValueAmountType value) Sets the value of the valueAmount 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

PrizeType

public PrizeType()

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

Method Detail

getUBLExtensions

@Nullable
public UBLExtensionsType getUBLExtensions()

Gets the value of the ublExtensions property.

Returns:

possible object is UBLExtensionsType

setUBLExtensions

public void setUBLExtensions(@Nullable
                             UBLExtensionsType value)

Sets the value of the ublExtensions property.

Parameters:

value - allowed object is UBLExtensionsType

getRankCode

@Nullable
public RankCodeType getRankCode()

Gets the value of the rankCode property.

Returns:

possible object is RankCodeType

setRankCode

public void setRankCode(@Nullable
                        RankCodeType value)

Sets the value of the rankCode property.

Parameters:

value - allowed object is RankCodeType

getValueAmount

@Nullable
public ValueAmountType getValueAmount()

Gets the value of the valueAmount property.

Returns:

possible object is ValueAmountType

setValueAmount

public void setValueAmount(@Nullable
                           ValueAmountType value)

Sets the value of the valueAmount property.

Parameters:

value - allowed object is ValueAmountType

getDescription

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DescriptionType> getDescription()

Gets the value of the description property. <p> 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 <CODE>set</CODE> method for the description property. <p> For example, to add a new item, do as follows: <pre> getDescription().add(newItem); </pre> <p> Objects of the following type(s) are allowed in the list DescriptionType

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

setDescription

public void setDescription(@Nullable
                           List<DescriptionType> aList)

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

Parameters:

aList - The new list member to set. May be <code>null</code>.

hasDescriptionEntries

public boolean hasDescriptionEntries()

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

Returns:

<code>true</code> if at least one item is contained, <code>false</code> otherwise.

hasNoDescriptionEntries

public boolean hasNoDescriptionEntries()

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

Returns:

<code>true</code> if no item is contained, <code>false</code> otherwise.

getDescriptionCount

@Nonnegative
public int getDescriptionCount()

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

Returns:

The number of contained elements. Always &ge; 0.

getDescriptionAtIndex

@Nullable
public DescriptionType getDescriptionAtIndex(@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 <code>null</code>

Throws:

IndexOutOfBoundsException - if the index is invalid!

addDescription

public void addDescription(@Nonnull
                           DescriptionType elem)

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

Parameters:

elem - The element to be added. May not be <code>null</code>.

cloneTo

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

setValueAmount

@Nonnull
public ValueAmountType setValueAmount(@Nullable
                                                BigDecimal valueParam)

Special setter with value of type BigDecimal<br> 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 ValueAmountType and never <code>null</code>

setRankCode

@Nonnull
public RankCodeType setRankCode(@Nullable
                                          String valueParam)

Special setter with value of type String<br> 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 RankCodeType and never <code>null</code>

getRankCodeValue

@Nullable
public String getRankCodeValue()

Get the value of the contained RankCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained RankCodeType object or <code>null</code>

getValueAmountValue

@Nullable
public BigDecimal getValueAmountValue()

Get the value of the contained ValueAmountType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained ValueAmountType object or <code>null</code>