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

Class OrderLineType

java.lang.Object

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

public class OrderLineType
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>Order Line. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to define a line in an order document (e.g., Order, Order Change, or Order Response) describing an item being ordered.</ccts:Definition>
                <ccts:ObjectClass>Order Line</ccts:ObjectClass>
             </ccts:Component>
 

Java class for OrderLineType complex type.

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

 <complexType name="OrderLineType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SubstitutionStatusCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Note" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}LineItem"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SellerProposedSubstituteLineItem" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SellerSubstitutedLineItem" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}BuyerProposedSubstituteLineItem" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}CatalogueLineReference" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}QuotationLineReference" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}OrderLineReference" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}DocumentReference" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<LineItemType>	buyerProposedSubstituteLineItem
protected LineReferenceType	catalogueLineReference
protected List<DocumentReferenceType>	documentReference
protected LineItemType	lineItem
protected List<NoteType>	note
protected List<OrderLineReferenceType>	orderLineReference
protected LineReferenceType	quotationLineReference
protected List<LineItemType>	sellerProposedSubstituteLineItem
protected List<LineItemType>	sellerSubstitutedLineItem
protected SubstitutionStatusCodeType	substitutionStatusCode

Constructor Summary

Constructors

Constructor and Description
OrderLineType()

Method Summary

Modifier and Type	Method and Description
List<LineItemType>	getBuyerProposedSubstituteLineItem() <?
LineReferenceType	getCatalogueLineReference() <?
List<DocumentReferenceType>	getDocumentReference() <?
LineItemType	getLineItem() <?
List<NoteType>	getNote() <?
List<OrderLineReferenceType>	getOrderLineReference() <?
LineReferenceType	getQuotationLineReference() <?
List<LineItemType>	getSellerProposedSubstituteLineItem() <?
List<LineItemType>	getSellerSubstitutedLineItem() <?
SubstitutionStatusCodeType	getSubstitutionStatusCode() <?
void	setCatalogueLineReference(LineReferenceType value) Sets the value of the catalogueLineReference property.
void	setLineItem(LineItemType value) Sets the value of the lineItem property.
void	setQuotationLineReference(LineReferenceType value) Sets the value of the quotationLineReference property.
void	setSubstitutionStatusCode(SubstitutionStatusCodeType value) Sets the value of the substitutionStatusCode property.

Methods inherited from class java.lang.Object

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

Field Detail

substitutionStatusCode

protected SubstitutionStatusCodeType substitutionStatusCode

note

protected List<NoteType> note

lineItem

protected LineItemType lineItem

sellerProposedSubstituteLineItem

protected List<LineItemType> sellerProposedSubstituteLineItem

sellerSubstitutedLineItem

protected List<LineItemType> sellerSubstitutedLineItem

buyerProposedSubstituteLineItem

protected List<LineItemType> buyerProposedSubstituteLineItem

catalogueLineReference

protected LineReferenceType catalogueLineReference

quotationLineReference

protected LineReferenceType quotationLineReference

orderLineReference

protected List<OrderLineReferenceType> orderLineReference

documentReference

protected List<DocumentReferenceType> documentReference

Constructor Detail

OrderLineType

public OrderLineType()

Method Detail

getSubstitutionStatusCode

public SubstitutionStatusCodeType getSubstitutionStatusCode()

 <?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>Order Line. Substitution Status Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the substitution status of the item on this order line. The order line may indicate that the substitute is proposed by the buyer (in Order) or by the seller (in Order Response) or that a substitution has been made by the seller (in Order Response).</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Substitution Status Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataTypeQualifier>Substitution Status</ccts:DataTypeQualifier>
                      <ccts:DataType>Substitution Status_ Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is SubstitutionStatusCodeType

setSubstitutionStatusCode

public void setSubstitutionStatusCode(SubstitutionStatusCodeType value)

Sets the value of the substitutionStatusCode property.

Parameters:

value - allowed object is SubstitutionStatusCodeType

getNote

public List<NoteType> getNote()

 <?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>Order Line. Note. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Free-form text conveying information that is not contained explicitly in other structures.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Note</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

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

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

    getNote().add(newItem);
 

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

getLineItem

public LineItemType getLineItem()

 <?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>Order Line. Line Item</ccts:DictionaryEntryName>
                      <ccts:Definition>The line item itself.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Line Item</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Line Item</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Line Item</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is LineItemType

setLineItem

public void setLineItem(LineItemType value)

Sets the value of the lineItem property.

Parameters:

value - allowed object is LineItemType

getSellerProposedSubstituteLineItem

public List<LineItemType> getSellerProposedSubstituteLineItem()

 <?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>Order Line. Seller Proposed Substitute_ Line Item. Line Item</ccts:DictionaryEntryName>
                      <ccts:Definition>In Order Response, a line item proposed by the seller describing a product that might substitute for the product described in this order line.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Seller Proposed Substitute</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Line Item</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Line Item</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Line Item</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getSellerProposedSubstituteLineItem().add(newItem);
 

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

getSellerSubstitutedLineItem

public List<LineItemType> getSellerSubstitutedLineItem()

 <?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>Order Line. Seller Substituted_ Line Item. Line Item</ccts:DictionaryEntryName>
                      <ccts:Definition>In Order Response, a line item that has replaced the original order line item. The specified quantity and pricing may differ from those in the original line item, but when a line item is substituted by the seller, it is assumed that other information, such as shipment details, will remain the same.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Seller Substituted</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Line Item</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Line Item</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Line Item</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getSellerSubstitutedLineItem().add(newItem);
 

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

getBuyerProposedSubstituteLineItem

public List<LineItemType> getBuyerProposedSubstituteLineItem()

 <?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>Order Line. Buyer Proposed Substitute_ Line Item. Line Item</ccts:DictionaryEntryName>
                      <ccts:Definition>A description of an item proposed by the buyer as a possible alternative to the item associated with this order line.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Buyer Proposed Substitute</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Line Item</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Line Item</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Line Item</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getBuyerProposedSubstituteLineItem().add(newItem);
 

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

getCatalogueLineReference

public LineReferenceType getCatalogueLineReference()

 <?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>Order Line. Catalogue_ Line Reference. Line Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>A reference to a catalogue line associated with this order line.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Catalogue</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Line Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Line Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Line Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is LineReferenceType

setCatalogueLineReference

public void setCatalogueLineReference(LineReferenceType value)

Sets the value of the catalogueLineReference property.

Parameters:

value - allowed object is LineReferenceType

getQuotationLineReference

public LineReferenceType getQuotationLineReference()

 <?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>Order Line. Quotation_ Line Reference. Line Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>A reference to a quotation line associated with this order line.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Quotation</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Line Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Line Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Line Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is LineReferenceType

setQuotationLineReference

public void setQuotationLineReference(LineReferenceType value)

Sets the value of the quotationLineReference property.

Parameters:

value - allowed object is LineReferenceType

getOrderLineReference

public List<OrderLineReferenceType> getOrderLineReference()

 <?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>Order Line. Order Line Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>A reference to another order line, such as in a replacement order or another line on the same order that is related.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Order Line Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Order Line Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Order Line Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getOrderLineReference().add(newItem);
 

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

getDocumentReference

public List<DocumentReferenceType> getDocumentReference()

 <?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>Order Line. Document Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>A reference to a document associated with this order line.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Order Line</ccts:ObjectClass>
                      <ccts:PropertyTerm>Document Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Document Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Document Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getDocumentReference().add(newItem);
 

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