oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.ItemPropertyType Maven / Gradle / Ivy
package oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
import com.phloc.commons.annotations.ReturnsMutableObject;
import com.phloc.commons.equals.EqualsUtils;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_2.NameType;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_2.ValueType;
/**
*
*
* <?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>Item Property. Details</ccts:DictionaryEntryName><ccts:Definition>Information about specific Item Properties.</ccts:Definition><ccts:ObjectClass>Item Property</ccts:ObjectClass></ccts:Component>
*
*
*
* Java class for ItemPropertyType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="ItemPropertyType">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Name"/>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Value"/>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}UsabilityPeriod" minOccurs="0"/>
* <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ItemPropertyGroup" maxOccurs="unbounded" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ItemPropertyType", propOrder = {
"name",
"value",
"usabilityPeriod",
"itemPropertyGroup"
})
public class ItemPropertyType implements Serializable
{
@XmlElement(name = "Name", namespace = "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2", required = true)
private NameType name;
@XmlElement(name = "Value", namespace = "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2", required = true)
private ValueType value;
@XmlElement(name = "UsabilityPeriod")
private PeriodType usabilityPeriod;
@XmlElement(name = "ItemPropertyGroup")
private List itemPropertyGroup;
/**
* Default constructor
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
*/
public ItemPropertyType() {
}
/**
* Constructor for value of type ValueType
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @param valueParam
* The value to be set. May be null.
*/
public ItemPropertyType(
@Nullable
final ValueType valueParam) {
setValue(valueParam);
}
/**
*
*
* <?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>Item Property. Name</ccts:DictionaryEntryName><ccts:Definition>The name of the Item Property.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Item Property</ccts:ObjectClass><ccts:PropertyTerm>Name</ccts:PropertyTerm><ccts:RepresentationTerm>Name</ccts:RepresentationTerm><ccts:DataType>Name. Type</ccts:DataType><ccts:Examples>"Energy Rating", "Collar Size", "Fat Content"</ccts:Examples></ccts:Component>
*
*
*
* @return
* possible object is
* {@link NameType }
*
*/
@Nullable
public NameType getName() {
return name;
}
/**
* Sets the value of the name property.
*
* @param value
* allowed object is
* {@link NameType }
*
*/
public void setName(
@Nullable
NameType valueParam) {
this.name = valueParam;
}
/**
*
*
* <?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>Item Property. Value. Text</ccts:DictionaryEntryName><ccts:Definition>The Item Property value.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Item Property</ccts:ObjectClass><ccts:PropertyTerm>Value</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:Examples>"100 watts", "15 European", "20% +/- 5%"</ccts:Examples></ccts:Component>
*
*
*
* @return
* possible object is
* {@link ValueType }
*
*/
@Nullable
public ValueType getValue() {
return value;
}
/**
* Sets the value of the value property.
*
* @param value
* allowed object is
* {@link ValueType }
*
*/
public void setValue(
@Nullable
ValueType valueParam) {
this.value = valueParam;
}
/**
*
*
* <?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>Item Property. Usability_ Period. Period</ccts:DictionaryEntryName><ccts:Definition>The period for which the Item Property is valid.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Item Property</ccts:ObjectClass><ccts:PropertyTermQualifier>Usability</ccts:PropertyTermQualifier><ccts:PropertyTerm>Period</ccts:PropertyTerm><ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass></ccts:Component>
*
*
*
* @return
* possible object is
* {@link PeriodType }
*
*/
@Nullable
public PeriodType getUsabilityPeriod() {
return usabilityPeriod;
}
/**
* Sets the value of the usabilityPeriod property.
*
* @param value
* allowed object is
* {@link PeriodType }
*
*/
public void setUsabilityPeriod(
@Nullable
PeriodType valueParam) {
this.usabilityPeriod = valueParam;
}
/**
*
*
* <?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>Item Property. Item Property Group</ccts:DictionaryEntryName><ccts:Definition>An association to Item Property Group.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Item Property</ccts:ObjectClass><ccts:PropertyTerm>Item Property Group</ccts:PropertyTerm><ccts:AssociatedObjectClass>Item Property Group</ccts:AssociatedObjectClass></ccts:Component>
*
* Gets the value of the itemPropertyGroup 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 itemPropertyGroup property.
*
*
* For example, to add a new item, do as follows:
*
* getItemPropertyGroup().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link ItemPropertyGroupType }
*
*
*/
@Nonnull
@ReturnsMutableObject(reason = "JAXB implementation style")
public List getItemPropertyGroup() {
if (itemPropertyGroup == null) {
itemPropertyGroup = new ArrayList();
}
return this.itemPropertyGroup;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-equalshashcode
*
*/
@Override
public boolean equals(final Object o) {
if (o == this) {
return true;
}
if ((o == null)||(!getClass().equals(o.getClass()))) {
return false;
}
final ItemPropertyType rhs = ((ItemPropertyType) o);
if (!EqualsUtils.equals(name, rhs.name)) {
return false;
}
if (!EqualsUtils.equals(value, rhs.value)) {
return false;
}
if (!EqualsUtils.equals(usabilityPeriod, rhs.usabilityPeriod)) {
return false;
}
if (!EqualsUtils.equals(itemPropertyGroup, rhs.itemPropertyGroup)) {
return false;
}
return true;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-equalshashcode
*
*/
@Override
public int hashCode() {
return new HashCodeGenerator(this).append(name).append(value).append(usabilityPeriod).append(itemPropertyGroup).getHashCode();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-tostring
*
*/
@Override
public String toString() {
return new ToStringGenerator(this).append("name", name).append("value", value).append("usabilityPeriod", usabilityPeriod).append("itemPropertyGroup", itemPropertyGroup).toString();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setItemPropertyGroup(
@Nullable
final List aList) {
itemPropertyGroup = aList;
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasItemPropertyGroupEntries() {
return (!getItemPropertyGroup().isEmpty());
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoItemPropertyGroupEntries() {
return getItemPropertyGroup().isEmpty();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getItemPropertyGroupCount() {
return getItemPropertyGroup().size();
}
/**
* Created by phloc-jaxb22-plugin -Xphloc-list-extension
*
* @param index
* The index to retrieve
* @return
* The element at the specified index. May be null
* @throws ArrayIndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public ItemPropertyGroupType getItemPropertyGroupAtIndex(
@Nonnegative
final int index) {
return getItemPropertyGroup().get(index);
}
/**
* Special setter with value of type String
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @param valueParam
* The value to be set. May be null.
* @return
* The created intermediary object of type ValueType and never null
*/
@Nonnull
public ValueType setValue(
@Nullable
final String valueParam) {
ValueType aObj = getValue();
if (aObj == null) {
aObj = new ValueType(valueParam);
setValue(aObj);
} else {
aObj.setValue(valueParam);
}
return aObj;
}
/**
* Special setter with value of type String
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @param valueParam
* The value to be set. May be null.
* @return
* The created intermediary object of type NameType and never null
*/
@Nonnull
public NameType setName(
@Nullable
final String valueParam) {
NameType aObj = getName();
if (aObj == null) {
aObj = new NameType(valueParam);
setName(aObj);
} else {
aObj.setValue(valueParam);
}
return aObj;
}
/**
* Get the value of the contained NameType object
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @return
* Either the value of the contained NameType object or null
*/
@Nullable
public String getNameValue() {
NameType aObj = getName();
return ((aObj == null)?null:aObj.getValue());
}
/**
* Get the value of the contained ValueType object
* Created by phloc-ubl-jaxb-plugin -Xphloc-ubl-value
*
* @return
* Either the value of the contained ValueType object or null
*/
@Nullable
public String getValueValue() {
ValueType aObj = getValue();
return ((aObj == null)?null:aObj.getValue());
}
}