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

Class LocationType

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class LocationType
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>Location. Details</ccts:DictionaryEntryName><ccts:Definition>Information about 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" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Conditions" 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:CommonAggregateComponents-2}ValidityPeriod" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Address" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocationType() 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
AddressType	getAddress() <?
ConditionsType	getConditions() <?
String	getConditionsValue() Get the value of the contained ConditionsType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
CountrySubentityType	getCountrySubentity() <?
CountrySubentityCodeType	getCountrySubentityCode() <?
String	getCountrySubentityCodeValue() Get the value of the contained CountrySubentityCodeType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
String	getCountrySubentityValue() Get the value of the contained CountrySubentityType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
DescriptionType	getDescription() <?
String	getDescriptionValue() Get the value of the contained DescriptionType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
IDType	getID() <?
String	getIDValue() Get the value of the contained IDType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
List<PeriodType>	getValidityPeriod() <?
PeriodType	getValidityPeriodAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getValidityPeriodCount() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoValidityPeriodEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasValidityPeriodEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setAddress(AddressType value) Sets the value of the address property.
void	setConditions(ConditionsType value) Sets the value of the conditions property.
ConditionsType	setConditions(String valueParam) Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setCountrySubentity(CountrySubentityType value) Sets the value of the countrySubentity property.
CountrySubentityType	setCountrySubentity(String valueParam) Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setCountrySubentityCode(CountrySubentityCodeType value) Sets the value of the countrySubentityCode property.
CountrySubentityCodeType	setCountrySubentityCode(String valueParam) Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setDescription(DescriptionType value) Sets the value of the description property.
DescriptionType	setDescription(String valueParam) Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setID(IDType value) Sets the value of the id property.
IDType	setID(String valueParam) Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setValidityPeriod(List<PeriodType> 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

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

Constructor Detail

LocationType

public LocationType()

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

Method Detail

getID

@Nullable
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: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>Location. Identifier</ccts:DictionaryEntryName><ccts:Definition>The unique identifier for the 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(@Nullable
         IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

getDescription

@Nullable
public 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>Location. Description. Text</ccts:DictionaryEntryName><ccts:Definition>The description or name of the location.</ccts:Definition><ccts:Cardinality>0..1</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>
 

Returns:

possible object is DescriptionType

setDescription

public void setDescription(@Nullable
                  DescriptionType value)

Sets the value of the description property.

Parameters:

value - allowed object is DescriptionType

getConditions

@Nullable
public 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: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>Location. Conditions. Text</ccts:DictionaryEntryName><ccts:Definition>Conditions describing the location.</ccts:Definition><ccts:Cardinality>0..1</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>
 

Returns:

possible object is ConditionsType

setConditions

public void setConditions(@Nullable
                 ConditionsType value)

Sets the value of the conditions property.

Parameters:

value - allowed object is ConditionsType

getCountrySubentity

@Nullable
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: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>Location. Country Subentity. Text</ccts:DictionaryEntryName><ccts:Definition>A territorial division of a country, such as a county or state.</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(@Nullable
                       CountrySubentityType value)

Sets the value of the countrySubentity property.

Parameters:

value - allowed object is CountrySubentityType

getCountrySubentityCode

@Nullable
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: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>Location. Country Subentity Code. Code</ccts:DictionaryEntryName><ccts:Definition>The 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(@Nullable
                           CountrySubentityCodeType value)

Sets the value of the countrySubentityCode property.

Parameters:

value - allowed object is CountrySubentityCodeType

getValidityPeriod

@Nonnull
@ReturnsMutableObject(reason="JAXB implementation style")
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: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>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Location. Validity_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>Period(s) in which the 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: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

@Nullable
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: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>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Location. Address</ccts:DictionaryEntryName><ccts:Definition>Association to the address of the 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:Component>
 

Returns:

possible object is AddressType

setAddress

public void setAddress(@Nullable
              AddressType value)

Sets the value of the address property.

Parameters:

value - allowed object is AddressType

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

setValidityPeriod

public void setValidityPeriod(@Nullable
                     List<PeriodType> aList)

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

Parameters:

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

hasValidityPeriodEntries

public boolean hasValidityPeriodEntries()

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

Returns:

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

hasNoValidityPeriodEntries

public boolean hasNoValidityPeriodEntries()

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

Returns:

true if no item is contained, false otherwise.

getValidityPeriodCount

@Nonnegative
public int getValidityPeriodCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getValidityPeriodAtIndex

@Nullable
public PeriodType getValidityPeriodAtIndex(@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!

setDescription

@Nonnull
public DescriptionType setDescription(@Nullable
                                     String valueParam)

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

setConditions

@Nonnull
public ConditionsType setConditions(@Nullable
                                   String valueParam)

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

setCountrySubentity

@Nonnull
public CountrySubentityType setCountrySubentity(@Nullable
                                               String valueParam)

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

setID

@Nonnull
public IDType setID(@Nullable
                   String valueParam)

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

setCountrySubentityCode

@Nonnull
public CountrySubentityCodeType setCountrySubentityCode(@Nullable
                                                       String valueParam)

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

getIDValue

@Nullable
public String getIDValue()

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

Returns:

Either the value of the contained IDType object or null

getDescriptionValue

@Nullable
public String getDescriptionValue()

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

Returns:

Either the value of the contained DescriptionType object or null

getConditionsValue

@Nullable
public String getConditionsValue()

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

Returns:

Either the value of the contained ConditionsType object or null

getCountrySubentityValue

@Nullable
public String getCountrySubentityValue()

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

Returns:

Either the value of the contained CountrySubentityType object or null

getCountrySubentityCodeValue

@Nullable
public String getCountrySubentityCodeValue()

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

Returns:

Either the value of the contained CountrySubentityCodeType object or null