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

Class PeriodType

java.lang.Object

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

public class PeriodType
extends Object

 <?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>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<DescriptionType>	description
protected List<DescriptionCodeType>	descriptionCode
protected DurationMeasureType	durationMeasure
protected EndDateType	endDate
protected EndTimeType	endTime
protected StartDateType	startDate
protected StartTimeType	startTime

Constructor Summary

Constructors

Constructor and Description
PeriodType()

Method Summary

Modifier and Type	Method and Description
List<DescriptionType>	getDescription() <?
List<DescriptionCodeType>	getDescriptionCode() <?
DurationMeasureType	getDurationMeasure() <?
EndDateType	getEndDate() <?
EndTimeType	getEndTime() <?
StartDateType	getStartDate() <?
StartTimeType	getStartTime() <?
void	setDurationMeasure(DurationMeasureType value) Sets the value of the durationMeasure property.
void	setEndDate(EndDateType value) Sets the value of the endDate property.
void	setEndTime(EndTimeType value) Sets the value of the endTime property.
void	setStartDate(StartDateType value) Sets the value of the startDate property.
void	setStartTime(StartTimeType value) Sets the value of the startTime property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

startDate

protected StartDateType startDate

startTime

protected StartTimeType startTime

endDate

protected EndDateType endDate

endTime

protected EndTimeType endTime

durationMeasure

protected DurationMeasureType durationMeasure

descriptionCode

protected List<DescriptionCodeType> descriptionCode

description

protected List<DescriptionType> description

Constructor Detail

PeriodType

public PeriodType()

Method Detail

getStartDate

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(StartDateType value)

Sets the value of the startDate property.

Parameters:

value - allowed object is StartDateType

getStartTime

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(StartTimeType value)

Sets the value of the startTime property.

Parameters:

value - allowed object is StartTimeType

getEndDate

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(EndDateType value)

Sets the value of the endDate property.

Parameters:

value - allowed object is EndDateType

getEndTime

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(EndTimeType value)

Sets the value of the endTime property.

Parameters:

value - allowed object is EndTimeType

getDurationMeasure

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(DurationMeasureType value)

Sets the value of the durationMeasure property.

Parameters:

value - allowed object is DurationMeasureType

getDescriptionCode

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

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