oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class PeriodType

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class PeriodType
extends Object
implements Serializable

 <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Period. Details</ccts:DictionaryEntryName><ccts:Definition>Information about 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>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PeriodType() Default constructor Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Method Summary

Methods

Modifier and Type	Method and Description
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 Created by ph-ubl-jaxb-plugin -Xph-ubl-value
EndDateType	getEndDate() <?
XMLGregorianCalendar	getEndDateValue() Get the value of the contained EndDateType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
EndTimeType	getEndTime() <?
XMLGregorianCalendar	getEndTimeValue() Get the value of the contained EndTimeType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
StartDateType	getStartDate() <?
XMLGregorianCalendar	getStartDateValue() Get the value of the contained StartDateType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
StartTimeType	getStartTime() <?
XMLGregorianCalendar	getStartTimeValue() Get the value of the contained StartTimeType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
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 Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setDurationMeasure(DurationMeasureType value) Sets the value of the durationMeasure property.
void	setEndDate(EndDateType value) Sets the value of the endDate property.
EndDateType	setEndDate(XMLGregorianCalendar valueParam) Special setter with value of type XMLGregorianCalendar Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setEndTime(EndTimeType value) Sets the value of the endTime property.
EndTimeType	setEndTime(XMLGregorianCalendar valueParam) Special setter with value of type XMLGregorianCalendar Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setStartDate(StartDateType value) Sets the value of the startDate property.
StartDateType	setStartDate(XMLGregorianCalendar valueParam) Special setter with value of type XMLGregorianCalendar Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setStartTime(StartTimeType value) Sets the value of the startTime property.
StartTimeType	setStartTime(XMLGregorianCalendar valueParam) Special setter with value of type XMLGregorianCalendar Created by ph-ubl-jaxb-plugin -Xph-ubl-value
String	toString() Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PeriodType

public PeriodType()

Default constructor Created by ph-ubl-jaxb-plugin -Xph-ubl-value

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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule: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 start date of the period.</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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule: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 start time of the period.</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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule: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 end date of the period.</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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule: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 end time of the period.</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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule: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 a period, expressed as a code; ISO 8601.</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(reason="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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule: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 the 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(reason="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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule: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 the period.</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)

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:

ArrayIndexOutOfBoundsException - if the index is invalid!

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)

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:

ArrayIndexOutOfBoundsException - if the index is invalid!

setEndDate

@Nonnull
public EndDateType setEndDate(@Nullable
                             XMLGregorianCalendar valueParam)

Special setter with value of type XMLGregorianCalendar Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type EndDateType and never null

setStartDate

@Nonnull
public StartDateType setStartDate(@Nullable
                                 XMLGregorianCalendar valueParam)

Special setter with value of type XMLGregorianCalendar Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type StartDateType and never null

setStartTime

@Nonnull
public StartTimeType setStartTime(@Nullable
                                 XMLGregorianCalendar valueParam)

Special setter with value of type XMLGregorianCalendar Created by ph-ubl-jaxb-plugin -Xph-ubl-value

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
                             XMLGregorianCalendar valueParam)

Special setter with value of type XMLGregorianCalendar Created by ph-ubl-jaxb-plugin -Xph-ubl-value

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 Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type DurationMeasureType and never null

getStartDateValue

@Nullable
public XMLGregorianCalendar getStartDateValue()

Get the value of the contained StartDateType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Returns:

Either the value of the contained StartDateType object or null

getStartTimeValue

@Nullable
public XMLGregorianCalendar getStartTimeValue()

Get the value of the contained StartTimeType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Returns:

Either the value of the contained StartTimeType object or null

getEndDateValue

@Nullable
public XMLGregorianCalendar getEndDateValue()

Get the value of the contained EndDateType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Returns:

Either the value of the contained EndDateType object or null

getEndTimeValue

@Nullable
public XMLGregorianCalendar getEndTimeValue()

Get the value of the contained EndTimeType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Returns:

Either the value of the contained EndTimeType object or null

getDurationMeasureValue

@Nullable
public BigDecimal getDurationMeasureValue()

Get the value of the contained DurationMeasureType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Returns:

Either the value of the contained DurationMeasureType object or null