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

Class LocationType

java.lang.Object

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

public class LocationType
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>Location. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe a location.</ccts:Definition>
                <ccts:ObjectClass>Location</ccts:ObjectClass>
             </ccts:Component>
 

Java class for LocationType complex type.

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

 <complexType name="LocationType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Description" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Conditions" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CountrySubentity" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CountrySubentityCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LocationTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}InformationURI" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Name" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ValidityPeriod" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Address" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SubsidiaryLocation" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}LocationCoordinate" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected AddressType	address
protected List<ConditionsType>	conditions
protected CountrySubentityType	countrySubentity
protected CountrySubentityCodeType	countrySubentityCode
protected List<DescriptionType>	description
protected IDType	id
protected InformationURIType	informationURI
protected List<LocationCoordinateType>	locationCoordinate
protected LocationTypeCodeType	locationTypeCode
protected NameType	name
protected List<LocationType>	subsidiaryLocation
protected List<PeriodType>	validityPeriod

Constructor Summary

Constructors

Constructor and Description
LocationType()

Method Summary

Modifier and Type	Method and Description
AddressType	getAddress() <?
List<ConditionsType>	getConditions() <?
CountrySubentityType	getCountrySubentity() <?
CountrySubentityCodeType	getCountrySubentityCode() <?
List<DescriptionType>	getDescription() <?
IDType	getID() <?
InformationURIType	getInformationURI() <?
List<LocationCoordinateType>	getLocationCoordinate() <?
LocationTypeCodeType	getLocationTypeCode() <?
NameType	getName() <?
List<LocationType>	getSubsidiaryLocation() <?
List<PeriodType>	getValidityPeriod() <?
void	setAddress(AddressType value) Sets the value of the address property.
void	setCountrySubentity(CountrySubentityType value) Sets the value of the countrySubentity property.
void	setCountrySubentityCode(CountrySubentityCodeType value) Sets the value of the countrySubentityCode property.
void	setID(IDType value) Sets the value of the id property.
void	setInformationURI(InformationURIType value) Sets the value of the informationURI property.
void	setLocationTypeCode(LocationTypeCodeType value) Sets the value of the locationTypeCode property.
void	setName(NameType value) Sets the value of the name property.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected IDType id

description

protected List<DescriptionType> description

conditions

protected List<ConditionsType> conditions

countrySubentity

protected CountrySubentityType countrySubentity

countrySubentityCode

protected CountrySubentityCodeType countrySubentityCode

locationTypeCode

protected LocationTypeCodeType locationTypeCode

informationURI

protected InformationURIType informationURI

name

protected NameType name

validityPeriod

protected List<PeriodType> validityPeriod

address

protected AddressType address

subsidiaryLocation

protected List<LocationType> subsidiaryLocation

locationCoordinate

protected List<LocationCoordinateType> locationCoordinate

Constructor Detail

LocationType

public LocationType()

Method Detail

getID

public IDType getID()

 <?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>Location. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for this location, e.g., the EAN Location Number, GLN.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTerm>Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                      <ccts:Examples>5790002221134</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is IDType

setID

public void setID(IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

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>Location. Description. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Text describing this location.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Location</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

getConditions

public List<ConditionsType> getConditions()

 <?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>Location. Conditions. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Free-form text describing the physical conditions of the location.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTerm>Conditions</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

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

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

    getConditions().add(newItem);
 

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

getCountrySubentity

public CountrySubentityType getCountrySubentity()

 <?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>Location. Country Subentity. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>A territorial division of a country, such as a county or state, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTerm>Country Subentity</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:AlternativeBusinessTerms>AdministrativeArea, State, Country, Shire, Canton</ccts:AlternativeBusinessTerms>
                      <ccts:Examples>Florida , Tamilnadu </ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is CountrySubentityType

setCountrySubentity

public void setCountrySubentity(CountrySubentityType value)

Sets the value of the countrySubentity property.

Parameters:

value - allowed object is CountrySubentityType

getCountrySubentityCode

public CountrySubentityCodeType getCountrySubentityCode()

 <?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>Location. Country Subentity Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A territorial division of a country, such as a county or state, expressed as a code.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTerm>Country Subentity Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                      <ccts:AlternativeBusinessTerms>AdministrativeAreaCode, State Code</ccts:AlternativeBusinessTerms>
                   </ccts:Component>
 

Returns:

possible object is CountrySubentityCodeType

setCountrySubentityCode

public void setCountrySubentityCode(CountrySubentityCodeType value)

Sets the value of the countrySubentityCode property.

Parameters:

value - allowed object is CountrySubentityCodeType

getLocationTypeCode

public LocationTypeCodeType getLocationTypeCode()

 <?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>Location. Location Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the type of location.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTerm>Location Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is LocationTypeCodeType

setLocationTypeCode

public void setLocationTypeCode(LocationTypeCodeType value)

Sets the value of the locationTypeCode property.

Parameters:

value - allowed object is LocationTypeCodeType

getInformationURI

public InformationURIType getInformationURI()

 <?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>Location. Information_ URI. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>The Uniform Resource Identifier (URI) of a document providing information about this location.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Information</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>URI</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is InformationURIType

setInformationURI

public void setInformationURI(InformationURIType value)

Sets the value of the informationURI property.

Parameters:

value - allowed object is InformationURIType

getName

public NameType getName()

 <?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>Location. Name</ccts:DictionaryEntryName>
                      <ccts:Definition>The name of this location.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTerm>Name</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Name</ccts:RepresentationTerm>
                      <ccts:DataType>Name. Type</ccts:DataType>
                      <ccts:Examples>winter 2005 collection </ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is NameType

setName

public void setName(NameType value)

Sets the value of the name property.

Parameters:

value - allowed object is NameType

getValidityPeriod

public List<PeriodType> getValidityPeriod()

 <?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>Location. Validity_ Period. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>A period during which this location can be used (e.g., for delivery).</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Validity</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Period</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Period</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getValidityPeriod().add(newItem);
 

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

getAddress

public AddressType getAddress()

 <?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>Location. Address</ccts:DictionaryEntryName>
                      <ccts:Definition>The address of this location.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTerm>Address</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Address</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Address</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is AddressType

setAddress

public void setAddress(AddressType value)

Sets the value of the address property.

Parameters:

value - allowed object is AddressType

getSubsidiaryLocation

public List<LocationType> getSubsidiaryLocation()

 <?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>Location. Subsidiary_ Location. Location</ccts:DictionaryEntryName>
                      <ccts:Definition>A location subsidiary to this location.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Subsidiary</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Location</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Location</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Location</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getSubsidiaryLocation().add(newItem);
 

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

getLocationCoordinate

public List<LocationCoordinateType> getLocationCoordinate()

 <?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>Location. Location Coordinate</ccts:DictionaryEntryName>
                      <ccts:Definition>The geographical coordinates of this location.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Location</ccts:ObjectClass>
                      <ccts:PropertyTerm>Location Coordinate</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Location Coordinate</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Location Coordinate</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getLocationCoordinate().add(newItem);
 

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