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

Class FrameworkAgreementType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class FrameworkAgreementType
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>Framework Agreement. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a tendering framework agreement.</ccts:Definition><ccts:ObjectClass>Framework Agreement</ccts:ObjectClass></ccts:Component>
 

Java class for FrameworkAgreementType complex type.

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

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

Method Summary

Modifier and Type	Method and Description
void	addFrequency(FrequencyType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addJustification(JustificationType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addSubsequentProcessTenderRequirement(TenderRequirementType elem) Created by ph-jaxb22-plugin -Xph-list-extension
FrameworkAgreementType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(FrameworkAgreementType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
PeriodType	getDurationPeriod() <?
ExpectedOperatorQuantityType	getExpectedOperatorQuantity() <?
BigDecimal	getExpectedOperatorQuantityValue() Get the value of the contained ExpectedOperatorQuantityType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<FrequencyType>	getFrequency() <?
FrequencyType	getFrequencyAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getFrequencyCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<JustificationType>	getJustification() <?
JustificationType	getJustificationAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getJustificationCount() Created by ph-jaxb22-plugin -Xph-list-extension
MaximumOperatorQuantityType	getMaximumOperatorQuantity() <?
BigDecimal	getMaximumOperatorQuantityValue() Get the value of the contained MaximumOperatorQuantityType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<TenderRequirementType>	getSubsequentProcessTenderRequirement() <?
TenderRequirementType	getSubsequentProcessTenderRequirementAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getSubsequentProcessTenderRequirementCount() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasFrequencyEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasJustificationEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoFrequencyEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoJustificationEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoSubsequentProcessTenderRequirementEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasSubsequentProcessTenderRequirementEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setDurationPeriod(PeriodType value) Sets the value of the durationPeriod property.
ExpectedOperatorQuantityType	setExpectedOperatorQuantity(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setExpectedOperatorQuantity(ExpectedOperatorQuantityType value) Sets the value of the expectedOperatorQuantity property.
void	setFrequency(List<FrequencyType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setJustification(List<JustificationType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
MaximumOperatorQuantityType	setMaximumOperatorQuantity(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setMaximumOperatorQuantity(MaximumOperatorQuantityType value) Sets the value of the maximumOperatorQuantity property.
void	setSubsequentProcessTenderRequirement(List<TenderRequirementType> 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

FrameworkAgreementType

public FrameworkAgreementType()

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

Method Detail

getExpectedOperatorQuantity

@Nullable
public ExpectedOperatorQuantityType getExpectedOperatorQuantity()

 <?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>Framework Agreement. Expected_ Operator. Quantity</ccts:DictionaryEntryName><ccts:Definition>The number of economic operators expected to participate in this framework agreement.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Framework Agreement</ccts:ObjectClass><ccts:PropertyTermQualifier>Expected</ccts:PropertyTermQualifier><ccts:PropertyTerm>Operator</ccts:PropertyTerm><ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm><ccts:DataType>Quantity. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is ExpectedOperatorQuantityType

setExpectedOperatorQuantity

public void setExpectedOperatorQuantity(@Nullable
                                        ExpectedOperatorQuantityType value)

Sets the value of the expectedOperatorQuantity property.

Parameters:

value - allowed object is ExpectedOperatorQuantityType

getMaximumOperatorQuantity

@Nullable
public MaximumOperatorQuantityType getMaximumOperatorQuantity()

 <?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>Framework Agreement. Maximum_ Operator. Quantity</ccts:DictionaryEntryName><ccts:Definition>The maximum number of economic operators allowed to participate in this framework agreement.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Framework Agreement</ccts:ObjectClass><ccts:PropertyTermQualifier>Maximum</ccts:PropertyTermQualifier><ccts:PropertyTerm>Operator</ccts:PropertyTerm><ccts:RepresentationTerm>Quantity</ccts:RepresentationTerm><ccts:DataType>Quantity. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is MaximumOperatorQuantityType

setMaximumOperatorQuantity

public void setMaximumOperatorQuantity(@Nullable
                                       MaximumOperatorQuantityType value)

Sets the value of the maximumOperatorQuantity property.

Parameters:

value - allowed object is MaximumOperatorQuantityType

getJustification

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<JustificationType> getJustification()

 <?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>Framework Agreement. Justification. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing the justification for this framework agreement.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Framework Agreement</ccts:ObjectClass><ccts:PropertyTerm>Justification</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

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

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

    getJustification().add(newItem);
 

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

getFrequency

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<FrequencyType> getFrequency()

 <?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>Framework Agreement. Frequency. Text</ccts:DictionaryEntryName><ccts:Definition>Text describing the frequency with which subsequent contracts will be awarded.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Framework Agreement</ccts:ObjectClass><ccts:PropertyTerm>Frequency</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

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

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

    getFrequency().add(newItem);
 

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

getDurationPeriod

@Nullable
public PeriodType getDurationPeriod()

 <?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>Framework Agreement. Duration_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>The period during which this framework agreement applies.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Framework Agreement</ccts:ObjectClass><ccts:PropertyTermQualifier>Duration</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component>
 

Returns:

possible object is PeriodType

setDurationPeriod

public void setDurationPeriod(@Nullable
                              PeriodType value)

Sets the value of the durationPeriod property.

Parameters:

value - allowed object is PeriodType

getSubsequentProcessTenderRequirement

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<TenderRequirementType> getSubsequentProcessTenderRequirement()

 <?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>Framework Agreement. Subsequent Process_ Tender Requirement. Tender Requirement</ccts:DictionaryEntryName><ccts:Definition>A tender requirement intended for consumption by downstream tendering processes derived from the establishment of this framework agreement.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Framework Agreement</ccts:ObjectClass><ccts:PropertyTermQualifier>Subsequent Process</ccts:PropertyTermQualifier><ccts:PropertyTerm>Tender Requirement</ccts:PropertyTerm><ccts:AssociatedObjectClass>Tender Requirement</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Tender Requirement</ccts:RepresentationTerm><ccts:Examples>Curricula required</ccts:Examples></ccts:Component>
 

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

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

    getSubsequentProcessTenderRequirement().add(newItem);
 

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

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

setJustification

public void setJustification(@Nullable
                             List<JustificationType> aList)

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

Parameters:

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

setFrequency

public void setFrequency(@Nullable
                         List<FrequencyType> aList)

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

Parameters:

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

setSubsequentProcessTenderRequirement

public void setSubsequentProcessTenderRequirement(@Nullable
                                                  List<TenderRequirementType> aList)

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

Parameters:

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

hasJustificationEntries

public boolean hasJustificationEntries()

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

Returns:

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

hasNoJustificationEntries

public boolean hasNoJustificationEntries()

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

Returns:

true if no item is contained, false otherwise.

getJustificationCount

@Nonnegative
public int getJustificationCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getJustificationAtIndex

@Nullable
public JustificationType getJustificationAtIndex(@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!

addJustification

public void addJustification(@Nonnull
                             JustificationType elem)

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

Parameters:

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

hasFrequencyEntries

public boolean hasFrequencyEntries()

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

Returns:

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

hasNoFrequencyEntries

public boolean hasNoFrequencyEntries()

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

Returns:

true if no item is contained, false otherwise.

getFrequencyCount

@Nonnegative
public int getFrequencyCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getFrequencyAtIndex

@Nullable
public FrequencyType getFrequencyAtIndex(@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!

addFrequency

public void addFrequency(@Nonnull
                         FrequencyType elem)

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

Parameters:

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

hasSubsequentProcessTenderRequirementEntries

public boolean hasSubsequentProcessTenderRequirementEntries()

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

Returns:

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

hasNoSubsequentProcessTenderRequirementEntries

public boolean hasNoSubsequentProcessTenderRequirementEntries()

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

Returns:

true if no item is contained, false otherwise.

getSubsequentProcessTenderRequirementCount

@Nonnegative
public int getSubsequentProcessTenderRequirementCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getSubsequentProcessTenderRequirementAtIndex

@Nullable
public TenderRequirementType getSubsequentProcessTenderRequirementAtIndex(@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!

addSubsequentProcessTenderRequirement

public void addSubsequentProcessTenderRequirement(@Nonnull
                                                  TenderRequirementType 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
                    FrameworkAgreementType 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 FrameworkAgreementType 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.

setExpectedOperatorQuantity

@Nonnull
public ExpectedOperatorQuantityType setExpectedOperatorQuantity(@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 ExpectedOperatorQuantityType and never null

setMaximumOperatorQuantity

@Nonnull
public MaximumOperatorQuantityType setMaximumOperatorQuantity(@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 MaximumOperatorQuantityType and never null

getExpectedOperatorQuantityValue

@Nullable
public BigDecimal getExpectedOperatorQuantityValue()

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

Returns:

Either the value of the contained ExpectedOperatorQuantityType object or null

getMaximumOperatorQuantityValue

@Nullable
public BigDecimal getMaximumOperatorQuantityValue()

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

Returns:

Either the value of the contained MaximumOperatorQuantityType object or null