PriceListType (ph-ubl22 6.7.0 API)

java.lang.Object
- oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_22.PriceListType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class PriceListType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
```
<pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Price List. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a price list.</ccts:Definition><ccts:ObjectClass>Price List</ccts:ObjectClass></ccts:Component> </pre> Java class for PriceListType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="PriceListType"> <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}StatusCode" 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}PreviousPriceList" minOccurs="0"/> </sequence> </restriction> </complexContent> </complexType> </pre> This class was annotated by ph-jaxb22-plugin -Xph-annotate This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode This class contains methods created by ph-jaxb22-plugin -Xph-tostring This class contains methods created by ph-jaxb22-plugin -Xph-list-extension This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2 This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PriceListType()
Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Constructors
Constructor and Description
`PriceListType()` Default constructor<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValidityPeriod(PeriodType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`PriceListType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(PriceListType ret)` This method clones all values from <code>this</code> to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`IDType`	`getID()` <pre> <?
`String`	`getIDValue()` Get the value of the contained IDType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`PriceListType`	`getPreviousPriceList()` <pre> <?
`StatusCodeType`	`getStatusCode()` <pre> <?
`String`	`getStatusCodeValue()` Get the value of the contained StatusCodeType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`List<PeriodType>`	`getValidityPeriod()` <pre> <?
`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`	`setID(IDType value)` Sets the value of the id property.
`IDType`	`setID(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`void`	`setPreviousPriceList(PriceListType value)` Sets the value of the previousPriceList property.
`void`	`setStatusCode(StatusCodeType value)` Sets the value of the statusCode property.
`StatusCodeType`	`setStatusCode(String valueParam)` Special setter with value of type String<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`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
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - PriceListType
```
public PriceListType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getID
```
@Nullable
public IDType getID()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Price List. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for this price list.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Price List</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component> </pre>
 
 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
 - getStatusCode
```
@Nullable
public StatusCodeType getStatusCode()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Price List. Status Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying whether this price list is an original, copy, revision, or cancellation.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Price List</ccts:ObjectClass><ccts:PropertyTerm>Status Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType><ccts:Examples>new - announcement only , new and available , deleted - announcement only </ccts:Examples></ccts:Component> </pre>
 
 Returns:
 
 possible object is StatusCodeType
 - setStatusCode
```
public void setStatusCode(@Nullable
 StatusCodeType value)
```
 Sets the value of the statusCode property.
 
 Parameters:
 
 value - allowed object is StatusCodeType
 - getValidityPeriod
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<PeriodType> getValidityPeriod()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Price List. Validity_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>A period during which this price list is valid.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Price List</ccts:ObjectClass><ccts:PropertyTermQualifier>Validity</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Period</ccts:RepresentationTerm></ccts:Component> </pre> 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 <CODE>set</CODE> method for the validityPeriod property. For example, to add a new item, do as follows: <pre> getValidityPeriod().add(newItem); </pre> Objects of the following type(s) are allowed in the list PeriodType
 - getPreviousPriceList
```
@Nullable
public PriceListType getPreviousPriceList()
```
 <pre> <?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:p227754_="http://java.sun.com/xml/ns/jaxb/xjc" xmlns:p90972_="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Price List. Previous_ Price List. Price List</ccts:DictionaryEntryName><ccts:Definition>The previous price list.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Price List</ccts:ObjectClass><ccts:PropertyTermQualifier>Previous</ccts:PropertyTermQualifier><ccts:PropertyTerm>Price List</ccts:PropertyTerm><ccts:AssociatedObjectClass>Price List</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Price List</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is PriceListType
 - setPreviousPriceList
```
public void setPreviousPriceList(@Nullable
 PriceListType value)
```
 Sets the value of the previousPriceList property.
 
 Parameters:
 
 value - allowed object is PriceListType
 - 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 <code>null</code>.
 - hasValidityPeriodEntries
```
public boolean hasValidityPeriodEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoValidityPeriodEntries
```
public boolean hasNoValidityPeriodEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> 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)
 throws IndexOutOfBoundsException
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 index - The index to retrieve
 
 Returns:
 
 The element at the specified index. May be <code>null</code>
 
 Throws:
 
 IndexOutOfBoundsException - if the index is invalid!
 - addValidityPeriod
```
public void addValidityPeriod(@Nonnull
 PeriodType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - cloneTo
```
public void cloneTo(@Nonnull
 PriceListType ret)
```
 This method clones all values from <code>this</code> to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Parameters:
 
 ret - The target object to clone to. May not be <code>null</code>.
 - clone
```
@Nonnull
 @ReturnsMutableCopy
public PriceListType clone()
```
 Created by ph-jaxb22-plugin -Xph-cloneable2
 
 Specified by:
 
 clone in interface com.helger.commons.lang.IExplicitlyCloneable
 
 Overrides:
 
 clone in class Object
 
 Returns:
 
 The cloned object. Never <code>null</code>.
 - setStatusCode
```
@Nonnull
public StatusCodeType setStatusCode(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type StatusCodeType and never <code>null</code>
 - setID
```
@Nonnull
public IDType setID(@Nullable
 String valueParam)
```
 Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Parameters:
 
 valueParam - The value to be set. May be <code>null</code>.
 
 Returns:
 
 The created intermediary object of type IDType and never <code>null</code>
 - getIDValue
```
@Nullable
public String getIDValue()
```
 Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained IDType object or <code>null</code>
 - getStatusCodeValue
```
@Nullable
public String getStatusCodeValue()
```
 Get the value of the contained StatusCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained StatusCodeType object or <code>null</code>

Class PriceListType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PriceListType

Method Detail

getID

setID

getStatusCode

setStatusCode

getValidityPeriod

getPreviousPriceList

setPreviousPriceList

equals

hashCode

toString

setValidityPeriod

hasValidityPeriodEntries

hasNoValidityPeriodEntries

getValidityPeriodCount

getValidityPeriodAtIndex

addValidityPeriod

cloneTo

clone

setStatusCode

setID

getIDValue

getStatusCodeValue