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

Class ExternalReferenceType

java.lang.Object

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

public class ExternalReferenceType
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>External Reference. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe an external object, such as a document stored at a remote location.</ccts:Definition>
                <ccts:ObjectClass>External Reference</ccts:ObjectClass>
             </ccts:Component>
 

Java class for ExternalReferenceType complex type.

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

 <complexType name="ExternalReferenceType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}URI" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DocumentHash" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}HashAlgorithmMethod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ExpiryDate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ExpiryTime" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MimeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}FormatCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}EncodingCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CharacterSetCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}FileName" 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 CharacterSetCodeType	characterSetCode
protected List<DescriptionType>	description
protected DocumentHashType	documentHash
protected EncodingCodeType	encodingCode
protected ExpiryDateType	expiryDate
protected ExpiryTimeType	expiryTime
protected FileNameType	fileName
protected FormatCodeType	formatCode
protected HashAlgorithmMethodType	hashAlgorithmMethod
protected MimeCodeType	mimeCode
protected URIType	uri

Constructor Summary

Constructors

Constructor and Description
ExternalReferenceType()

Method Summary

Modifier and Type	Method and Description
CharacterSetCodeType	getCharacterSetCode() <?
List<DescriptionType>	getDescription() <?
DocumentHashType	getDocumentHash() <?
EncodingCodeType	getEncodingCode() <?
ExpiryDateType	getExpiryDate() <?
ExpiryTimeType	getExpiryTime() <?
FileNameType	getFileName() <?
FormatCodeType	getFormatCode() <?
HashAlgorithmMethodType	getHashAlgorithmMethod() <?
MimeCodeType	getMimeCode() <?
URIType	getURI() <?
void	setCharacterSetCode(CharacterSetCodeType value) Sets the value of the characterSetCode property.
void	setDocumentHash(DocumentHashType value) Sets the value of the documentHash property.
void	setEncodingCode(EncodingCodeType value) Sets the value of the encodingCode property.
void	setExpiryDate(ExpiryDateType value) Sets the value of the expiryDate property.
void	setExpiryTime(ExpiryTimeType value) Sets the value of the expiryTime property.
void	setFileName(FileNameType value) Sets the value of the fileName property.
void	setFormatCode(FormatCodeType value) Sets the value of the formatCode property.
void	setHashAlgorithmMethod(HashAlgorithmMethodType value) Sets the value of the hashAlgorithmMethod property.
void	setMimeCode(MimeCodeType value) Sets the value of the mimeCode property.
void	setURI(URIType value) Sets the value of the uri property.

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected URIType uri

documentHash

protected DocumentHashType documentHash

hashAlgorithmMethod

protected HashAlgorithmMethodType hashAlgorithmMethod

expiryDate

protected ExpiryDateType expiryDate

expiryTime

protected ExpiryTimeType expiryTime

mimeCode

protected MimeCodeType mimeCode

formatCode

protected FormatCodeType formatCode

encodingCode

protected EncodingCodeType encodingCode

characterSetCode

protected CharacterSetCodeType characterSetCode

fileName

protected FileNameType fileName

description

protected List<DescriptionType> description

Constructor Detail

ExternalReferenceType

public ExternalReferenceType()

Method Detail

getURI

public URIType getURI()

 <?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>External Reference. URI. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>The Uniform Resource Identifier (URI) that identifies the external object as an Internet resource.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>URI</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is URIType

setURI

public void setURI(URIType value)

Sets the value of the uri property.

Parameters:

value - allowed object is URIType

getDocumentHash

public DocumentHashType getDocumentHash()

 <?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>External Reference. Document Hash. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>A hash value for the externally stored object.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Document Hash</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is DocumentHashType

setDocumentHash

public void setDocumentHash(DocumentHashType value)

Sets the value of the documentHash property.

Parameters:

value - allowed object is DocumentHashType

getHashAlgorithmMethod

public HashAlgorithmMethodType getHashAlgorithmMethod()

 <?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>External Reference. Hash Algorithm Method. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>A hash algorithm used to calculate the hash value of the externally stored object.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Hash Algorithm Method</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is HashAlgorithmMethodType

setHashAlgorithmMethod

public void setHashAlgorithmMethod(HashAlgorithmMethodType value)

Sets the value of the hashAlgorithmMethod property.

Parameters:

value - allowed object is HashAlgorithmMethodType

getExpiryDate

public ExpiryDateType getExpiryDate()

 <?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>External Reference. Expiry Date. Date</ccts:DictionaryEntryName>
                      <ccts:Definition>The date on which availability of the resource can no longer be relied upon.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Expiry Date</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Date</ccts:RepresentationTerm>
                      <ccts:DataType>Date. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is ExpiryDateType

setExpiryDate

public void setExpiryDate(ExpiryDateType value)

Sets the value of the expiryDate property.

Parameters:

value - allowed object is ExpiryDateType

getExpiryTime

public ExpiryTimeType getExpiryTime()

 <?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>External Reference. Expiry Time. Time</ccts:DictionaryEntryName>
                      <ccts:Definition>The time after which availability of the resource can no longer be relied upon.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Expiry Time</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Time</ccts:RepresentationTerm>
                      <ccts:DataType>Time. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is ExpiryTimeType

setExpiryTime

public void setExpiryTime(ExpiryTimeType value)

Sets the value of the expiryTime property.

Parameters:

value - allowed object is ExpiryTimeType

getMimeCode

public MimeCodeType getMimeCode()

 <?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>External Reference. Mime Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the mime type of the external object.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Mime Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is MimeCodeType

setMimeCode

public void setMimeCode(MimeCodeType value)

Sets the value of the mimeCode property.

Parameters:

value - allowed object is MimeCodeType

getFormatCode

public FormatCodeType getFormatCode()

 <?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>External Reference. Format Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the format of the external object.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Format Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is FormatCodeType

setFormatCode

public void setFormatCode(FormatCodeType value)

Sets the value of the formatCode property.

Parameters:

value - allowed object is FormatCodeType

getEncodingCode

public EncodingCodeType getEncodingCode()

 <?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>External Reference. Encoding Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the encoding/decoding algorithm used with the external object.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Encoding Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is EncodingCodeType

setEncodingCode

public void setEncodingCode(EncodingCodeType value)

Sets the value of the encodingCode property.

Parameters:

value - allowed object is EncodingCodeType

getCharacterSetCode

public CharacterSetCodeType getCharacterSetCode()

 <?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>External Reference. Character Set Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the character set of an external document.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Character Set Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is CharacterSetCodeType

setCharacterSetCode

public void setCharacterSetCode(CharacterSetCodeType value)

Sets the value of the characterSetCode property.

Parameters:

value - allowed object is CharacterSetCodeType

getFileName

public FileNameType getFileName()

 <?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>External Reference. File Name. Name</ccts:DictionaryEntryName>
                      <ccts:Definition>The file name of the external object.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>File Name</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Name</ccts:RepresentationTerm>
                      <ccts:DataType>Name. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is FileNameType

setFileName

public void setFileName(FileNameType value)

Sets the value of the fileName property.

Parameters:

value - allowed object is FileNameType

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>External Reference. Description. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Text describing the external object.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>External Reference</ccts:ObjectClass>
                      <ccts:PropertyTerm>Description</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                      <ccts:Examples>computer accessories for laptops </ccts:Examples>
                   </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