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

Class PeriodType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class PeriodType
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>Period. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a period of time.</ccts:Definition><ccts:ObjectClass>Period</ccts:ObjectClass></ccts:Component>
 

Java class for PeriodType complex type.

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

 <complexType name="PeriodType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}StartDate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}StartTime" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}EndDate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}EndTime" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DurationMeasure" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DescriptionCode" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Description" 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
PeriodType() Default constructor 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
void	addDescriptionCode(DescriptionCodeType elem) Created by ph-jaxb22-plugin -Xph-list-extension
PeriodType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(PeriodType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<DescriptionType>	getDescription() <?
DescriptionType	getDescriptionAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
List<DescriptionCodeType>	getDescriptionCode() <?
DescriptionCodeType	getDescriptionCodeAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getDescriptionCodeCount() Created by ph-jaxb22-plugin -Xph-list-extension
int	getDescriptionCount() Created by ph-jaxb22-plugin -Xph-list-extension
DurationMeasureType	getDurationMeasure() <?
BigDecimal	getDurationMeasureValue() Get the value of the contained DurationMeasureType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
EndDateType	getEndDate() <?
LocalDate	getEndDateValue() Get the value of the contained EndDateType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
EndTimeType	getEndTime() <?
LocalTime	getEndTimeValue() Get the value of the contained EndTimeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
StartDateType	getStartDate() <?
LocalDate	getStartDateValue() Get the value of the contained StartDateType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
StartTimeType	getStartTime() <?
LocalTime	getStartTimeValue() Get the value of the contained StartTimeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
boolean	hasDescriptionCodeEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoDescriptionCodeEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoDescriptionEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setDescription(List<DescriptionType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setDescriptionCode(List<DescriptionCodeType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
DurationMeasureType	setDurationMeasure(BigDecimal valueParam) Special setter with value of type BigDecimal Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setDurationMeasure(DurationMeasureType value) Sets the value of the durationMeasure property.
void	setEndDate(EndDateType value) Sets the value of the endDate property.
EndDateType	setEndDate(LocalDate valueParam) Special setter with value of type LocalDate Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setEndTime(EndTimeType value) Sets the value of the endTime property.
EndTimeType	setEndTime(LocalTime valueParam) Special setter with value of type LocalTime Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
StartDateType	setStartDate(LocalDate valueParam) Special setter with value of type LocalDate Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setStartDate(StartDateType value) Sets the value of the startDate property.
StartTimeType	setStartTime(LocalTime valueParam) Special setter with value of type LocalTime Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setStartTime(StartTimeType value) Sets the value of the startTime 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

PeriodType

public PeriodType()

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

Method Detail

getStartDate

@Nullable
public StartDateType getStartDate()

 <?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>Period. Start Date. Date</ccts:DictionaryEntryName><ccts:Definition>The date on which this period begins.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Period</ccts:ObjectClass><ccts:PropertyTerm>Start Date</ccts:PropertyTerm><ccts:RepresentationTerm>Date</ccts:RepresentationTerm><ccts:DataType>Date. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is StartDateType

setStartDate

public void setStartDate(@Nullable
                         StartDateType value)

Sets the value of the startDate property.

Parameters:

value - allowed object is StartDateType

getStartTime

@Nullable
public StartTimeType getStartTime()

 <?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>Period. Start Time. Time</ccts:DictionaryEntryName><ccts:Definition>The time at which this period begins.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Period</ccts:ObjectClass><ccts:PropertyTerm>Start Time</ccts:PropertyTerm><ccts:RepresentationTerm>Time</ccts:RepresentationTerm><ccts:DataType>Time. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is StartTimeType

setStartTime

public void setStartTime(@Nullable
                         StartTimeType value)

Sets the value of the startTime property.

Parameters:

value - allowed object is StartTimeType

getEndDate

@Nullable
public EndDateType getEndDate()

 <?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>Period. End Date. Date</ccts:DictionaryEntryName><ccts:Definition>The date on which this period ends.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Period</ccts:ObjectClass><ccts:PropertyTerm>End Date</ccts:PropertyTerm><ccts:RepresentationTerm>Date</ccts:RepresentationTerm><ccts:DataType>Date. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is EndDateType

setEndDate

public void setEndDate(@Nullable
                       EndDateType value)

Sets the value of the endDate property.

Parameters:

value - allowed object is EndDateType

getEndTime

@Nullable
public EndTimeType getEndTime()

 <?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>Period. End Time. Time</ccts:DictionaryEntryName><ccts:Definition>The time at which this period ends.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Period</ccts:ObjectClass><ccts:PropertyTerm>End Time</ccts:PropertyTerm><ccts:RepresentationTerm>Time</ccts:RepresentationTerm><ccts:DataType>Time. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is EndTimeType

setEndTime

public void setEndTime(@Nullable
                       EndTimeType value)

Sets the value of the endTime property.

Parameters:

value - allowed object is EndTimeType

getDurationMeasure

@Nullable
public DurationMeasureType getDurationMeasure()

 <?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>Period. Duration. Measure</ccts:DictionaryEntryName><ccts:Definition>The duration of this period, expressed as an ISO 8601 code.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Period</ccts:ObjectClass><ccts:PropertyTerm>Duration</ccts:PropertyTerm><ccts:RepresentationTerm>Measure</ccts:RepresentationTerm><ccts:DataType>Measure. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is DurationMeasureType

setDurationMeasure

public void setDurationMeasure(@Nullable
                               DurationMeasureType value)

Sets the value of the durationMeasure property.

Parameters:

value - allowed object is DurationMeasureType

getDescriptionCode

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<DescriptionCodeType> getDescriptionCode()

 <?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>Period. Description Code. Code</ccts:DictionaryEntryName><ccts:Definition>A description of this period, expressed as a code.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Period</ccts:ObjectClass><ccts:PropertyTerm>Description Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

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

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

    getDescriptionCode().add(newItem);
 

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

getDescription

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

 <?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>Period. Description. Text</ccts:DictionaryEntryName><ccts:Definition>A description of this period, expressed as text.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Period</ccts:ObjectClass><ccts:PropertyTerm>Description</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

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

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

    getDescription().add(newItem);
 

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

setDescriptionCode

public void setDescriptionCode(@Nullable
                               List<DescriptionCodeType> aList)

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

Parameters:

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

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 null.

hasDescriptionCodeEntries

public boolean hasDescriptionCodeEntries()

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

Returns:

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

hasNoDescriptionCodeEntries

public boolean hasNoDescriptionCodeEntries()

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

Returns:

true if no item is contained, false otherwise.

getDescriptionCodeCount

@Nonnegative
public int getDescriptionCodeCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getDescriptionCodeAtIndex

@Nullable
public DescriptionCodeType getDescriptionCodeAtIndex(@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!

addDescriptionCode

public void addDescriptionCode(@Nonnull
                               DescriptionCodeType elem)

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

Parameters:

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

hasDescriptionEntries

public boolean hasDescriptionEntries()

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

Returns:

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

hasNoDescriptionEntries

public boolean hasNoDescriptionEntries()

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

Returns:

true if no item is contained, false otherwise.

getDescriptionCount

@Nonnegative
public int getDescriptionCount()

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

Returns:

The number of contained elements. Always ≥ 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 null

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 null.

cloneTo

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

setStartDate

@Nonnull
public StartDateType setStartDate(@Nullable
                                            LocalDate valueParam)

Special setter with value of type LocalDate
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 StartDateType and never null

setEndDate

@Nonnull
public EndDateType setEndDate(@Nullable
                                        LocalDate valueParam)

Special setter with value of type LocalDate
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 EndDateType and never null

setStartTime

@Nonnull
public StartTimeType setStartTime(@Nullable
                                            LocalTime valueParam)

Special setter with value of type LocalTime
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 StartTimeType and never null

setEndTime

@Nonnull
public EndTimeType setEndTime(@Nullable
                                        LocalTime valueParam)

Special setter with value of type LocalTime
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 EndTimeType and never null

setDurationMeasure

@Nonnull
public DurationMeasureType setDurationMeasure(@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 DurationMeasureType and never null

getStartDateValue

@Nullable
public LocalDate getStartDateValue()

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

Returns:

Either the value of the contained StartDateType object or null

getStartTimeValue

@Nullable
public LocalTime getStartTimeValue()

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

Returns:

Either the value of the contained StartTimeType object or null

getEndDateValue

@Nullable
public LocalDate getEndDateValue()

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

Returns:

Either the value of the contained EndDateType object or null

getEndTimeValue

@Nullable
public LocalTime getEndTimeValue()

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

Returns:

Either the value of the contained EndTimeType object or null

getDurationMeasureValue

@Nullable
public BigDecimal getDurationMeasureValue()

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

Returns:

Either the value of the contained DurationMeasureType object or null