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

Class ContractExtensionType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class ContractExtensionType
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>Contract Extension. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe possible extensions to a contract.</ccts:Definition><ccts:ObjectClass>Contract Extension</ccts:ObjectClass></ccts:Component>
 

Java class for ContractExtensionType complex type.

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

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

Method Summary

Modifier and Type	Method and Description
void	addOptionsDescription(OptionsDescriptionType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addRenewal(RenewalType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ContractExtensionType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ContractExtensionType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
MaximumNumberNumericType	getMaximumNumberNumeric() <?
BigDecimal	getMaximumNumberNumericValue() Get the value of the contained MaximumNumberNumericType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
MinimumNumberNumericType	getMinimumNumberNumeric() <?
BigDecimal	getMinimumNumberNumericValue() Get the value of the contained MinimumNumberNumericType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<OptionsDescriptionType>	getOptionsDescription() <?
OptionsDescriptionType	getOptionsDescriptionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getOptionsDescriptionCount() Created by ph-jaxb22-plugin -Xph-list-extension
PeriodType	getOptionValidityPeriod() <?
List<RenewalType>	getRenewal() <?
RenewalType	getRenewalAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getRenewalCount() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoOptionsDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoRenewalEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasOptionsDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasRenewalEntries() Created by ph-jaxb22-plugin -Xph-list-extension
MaximumNumberNumericType	setMaximumNumberNumeric(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setMaximumNumberNumeric(MaximumNumberNumericType value) Sets the value of the maximumNumberNumeric property.
MinimumNumberNumericType	setMinimumNumberNumeric(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setMinimumNumberNumeric(MinimumNumberNumericType value) Sets the value of the minimumNumberNumeric property.
void	setOptionsDescription(List<OptionsDescriptionType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setOptionValidityPeriod(PeriodType value) Sets the value of the optionValidityPeriod property.
void	setRenewal(List<RenewalType> 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

ContractExtensionType

public ContractExtensionType()

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

Method Detail

getOptionsDescription

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<OptionsDescriptionType> getOptionsDescription()

 <?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>Contract Extension. Options Description. Text</ccts:DictionaryEntryName><ccts:Definition>A description for the possible options that can be carried out during the execution of the contract.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Contract Extension</ccts:ObjectClass><ccts:PropertyTerm>Options Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

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

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

    getOptionsDescription().add(newItem);
 

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

getMinimumNumberNumeric

@Nullable
public MinimumNumberNumericType getMinimumNumberNumeric()

 <?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>Contract Extension. Minimum_ Number. Numeric</ccts:DictionaryEntryName><ccts:Definition>The fixed minimum number of contract extensions or renewals.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Contract Extension</ccts:ObjectClass><ccts:PropertyTermQualifier>Minimum</ccts:PropertyTermQualifier><ccts:PropertyTerm>Number</ccts:PropertyTerm><ccts:RepresentationTerm>Numeric</ccts:RepresentationTerm><ccts:DataType>Numeric. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is MinimumNumberNumericType

setMinimumNumberNumeric

public void setMinimumNumberNumeric(@Nullable
                                    MinimumNumberNumericType value)

Sets the value of the minimumNumberNumeric property.

Parameters:

value - allowed object is MinimumNumberNumericType

getMaximumNumberNumeric

@Nullable
public MaximumNumberNumericType getMaximumNumberNumeric()

 <?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>Contract Extension. Maximum_ Number. Numeric</ccts:DictionaryEntryName><ccts:Definition>The maximum allowed number of contract extensions.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Contract Extension</ccts:ObjectClass><ccts:PropertyTermQualifier>Maximum</ccts:PropertyTermQualifier><ccts:PropertyTerm>Number</ccts:PropertyTerm><ccts:RepresentationTerm>Numeric</ccts:RepresentationTerm><ccts:DataType>Numeric. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is MaximumNumberNumericType

setMaximumNumberNumeric

public void setMaximumNumberNumeric(@Nullable
                                    MaximumNumberNumericType value)

Sets the value of the maximumNumberNumeric property.

Parameters:

value - allowed object is MaximumNumberNumericType

getOptionValidityPeriod

@Nullable
public PeriodType getOptionValidityPeriod()

 <?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>Contract Extension. Option Validity_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>The period during which the option for extending the contract is available.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Contract Extension</ccts:ObjectClass><ccts:PropertyTermQualifier>Option Validity</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is PeriodType

setOptionValidityPeriod

public void setOptionValidityPeriod(@Nullable
                                    PeriodType value)

Sets the value of the optionValidityPeriod property.

Parameters:

value - allowed object is PeriodType

getRenewal

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<RenewalType> getRenewal()

 <?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>Contract Extension. Renewal</ccts:DictionaryEntryName><ccts:Definition>The period allowed for each contract extension.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Contract Extension</ccts:ObjectClass><ccts:PropertyTerm>Renewal</ccts:PropertyTerm><ccts:AssociatedObjectClass>Renewal</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Renewal</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getRenewal().add(newItem);
 

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

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

setOptionsDescription

public void setOptionsDescription(@Nullable
                                  List<OptionsDescriptionType> aList)

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

Parameters:

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

setRenewal

public void setRenewal(@Nullable
                       List<RenewalType> aList)

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

Parameters:

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

hasOptionsDescriptionEntries

public boolean hasOptionsDescriptionEntries()

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

Returns:

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

hasNoOptionsDescriptionEntries

public boolean hasNoOptionsDescriptionEntries()

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

Returns:

true if no item is contained, false otherwise.

getOptionsDescriptionCount

@Nonnegative
public int getOptionsDescriptionCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getOptionsDescriptionAtIndex

@Nullable
public OptionsDescriptionType getOptionsDescriptionAtIndex(@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!

addOptionsDescription

public void addOptionsDescription(@Nonnull
                                  OptionsDescriptionType elem)

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

Parameters:

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

hasRenewalEntries

public boolean hasRenewalEntries()

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

Returns:

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

hasNoRenewalEntries

public boolean hasNoRenewalEntries()

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

Returns:

true if no item is contained, false otherwise.

getRenewalCount

@Nonnegative
public int getRenewalCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getRenewalAtIndex

@Nullable
public RenewalType getRenewalAtIndex(@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!

addRenewal

public void addRenewal(@Nonnull
                       RenewalType 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
                    ContractExtensionType 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 ContractExtensionType 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.

setMinimumNumberNumeric

@Nonnull
public MinimumNumberNumericType setMinimumNumberNumeric(@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 MinimumNumberNumericType and never null

setMaximumNumberNumeric

@Nonnull
public MaximumNumberNumericType setMaximumNumberNumeric(@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 MaximumNumberNumericType and never null

getMinimumNumberNumericValue

@Nullable
public BigDecimal getMinimumNumberNumericValue()

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

Returns:

Either the value of the contained MinimumNumberNumericType object or null

getMaximumNumberNumericValue

@Nullable
public BigDecimal getMaximumNumberNumericValue()

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

Returns:

Either the value of the contained MaximumNumberNumericType object or null