oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21

Class PromotionalSpecificationType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.PromotionalSpecificationType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class PromotionalSpecificationType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

 <?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>Promotional Specification. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a promotional event as a set of item locations that share a set of promotional tactics.</ccts:Definition><ccts:ObjectClass>Promotional Specification</ccts:ObjectClass></ccts:Component>
 

Java class for PromotionalSpecificationType complex type.

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

 <complexType name="PromotionalSpecificationType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SpecificationID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}PromotionalEventLineItem" maxOccurs="unbounded"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}EventTactic" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

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
PromotionalSpecificationType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addEventTactic(EventTacticType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addPromotionalEventLineItem(PromotionalEventLineItemType elem) Created by ph-jaxb22-plugin -Xph-list-extension
PromotionalSpecificationType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(PromotionalSpecificationType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<EventTacticType>	getEventTactic() <?
EventTacticType	getEventTacticAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getEventTacticCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<PromotionalEventLineItemType>	getPromotionalEventLineItem() <?
PromotionalEventLineItemType	getPromotionalEventLineItemAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getPromotionalEventLineItemCount() Created by ph-jaxb22-plugin -Xph-list-extension
SpecificationIDType	getSpecificationID() <?
String	getSpecificationIDValue() Get the value of the contained SpecificationIDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
boolean	hasEventTacticEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoEventTacticEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoPromotionalEventLineItemEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasPromotionalEventLineItemEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setEventTactic(List<EventTacticType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setPromotionalEventLineItem(List<PromotionalEventLineItemType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setSpecificationID(SpecificationIDType value) Sets the value of the specificationID property.
SpecificationIDType	setSpecificationID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
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

PromotionalSpecificationType

public PromotionalSpecificationType()

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

Method Detail

getSpecificationID

@Nullable
public SpecificationIDType getSpecificationID()

 <?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>Promotional Specification. Specification Identifier. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for this promotional specification.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Promotional Specification</ccts:ObjectClass><ccts:PropertyTerm>Specification Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is SpecificationIDType

setSpecificationID

public void setSpecificationID(@Nullable
                               SpecificationIDType value)

Sets the value of the specificationID property.

Parameters:

value - allowed object is SpecificationIDType

getPromotionalEventLineItem

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<PromotionalEventLineItemType> getPromotionalEventLineItem()

 <?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>Promotional Specification. Promotional Event Line Item</ccts:DictionaryEntryName><ccts:Definition>A line item for a promotional event involving a specific product at a specific location; it describes the expected impacts associated with the event and specifies the promotional price of the item."</ccts:Definition><ccts:Cardinality>1..n</ccts:Cardinality><ccts:ObjectClass>Promotional Specification</ccts:ObjectClass><ccts:PropertyTerm>Promotional Event Line Item</ccts:PropertyTerm><ccts:AssociatedObjectClass>Promotional Event Line Item</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Promotional Event Line Item</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getPromotionalEventLineItem().add(newItem);
 

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

getEventTactic

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<EventTacticType> getEventTactic()

 <?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>Promotional Specification. Event Tactic</ccts:DictionaryEntryName><ccts:Definition>An event tactic associated with this promotion.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Promotional Specification</ccts:ObjectClass><ccts:PropertyTerm>Event Tactic</ccts:PropertyTerm><ccts:AssociatedObjectClass>Event Tactic</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Event Tactic</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getEventTactic().add(newItem);
 

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

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

setPromotionalEventLineItem

public void setPromotionalEventLineItem(@Nullable
                                        List<PromotionalEventLineItemType> aList)

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

Parameters:

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

setEventTactic

public void setEventTactic(@Nullable
                           List<EventTacticType> aList)

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

Parameters:

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

hasPromotionalEventLineItemEntries

public boolean hasPromotionalEventLineItemEntries()

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

Returns:

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

hasNoPromotionalEventLineItemEntries

public boolean hasNoPromotionalEventLineItemEntries()

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

Returns:

true if no item is contained, false otherwise.

getPromotionalEventLineItemCount

@Nonnegative
public int getPromotionalEventLineItemCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getPromotionalEventLineItemAtIndex

@Nullable
public PromotionalEventLineItemType getPromotionalEventLineItemAtIndex(@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 null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addPromotionalEventLineItem

public void addPromotionalEventLineItem(@Nonnull
                                        PromotionalEventLineItemType elem)

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

Parameters:

elem - The element to be added. May not be null.

hasEventTacticEntries

public boolean hasEventTacticEntries()

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

Returns:

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

hasNoEventTacticEntries

public boolean hasNoEventTacticEntries()

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

Returns:

true if no item is contained, false otherwise.

getEventTacticCount

@Nonnegative
public int getEventTacticCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getEventTacticAtIndex

@Nullable
public EventTacticType getEventTacticAtIndex(@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 null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addEventTactic

public void addEventTactic(@Nonnull
                           EventTacticType elem)

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

Parameters:

elem - The element to be added. May not be null.

cloneTo

public void cloneTo(@Nonnull
                    PromotionalSpecificationType ret)

This method clones all values from this 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 null.

clone

@Nonnull
 @ReturnsMutableCopy
public PromotionalSpecificationType 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 null.

setSpecificationID

@Nonnull
public SpecificationIDType setSpecificationID(@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 null.

Returns:

The created intermediary object of type SpecificationIDType and never null

getSpecificationIDValue

@Nullable
public String getSpecificationIDValue()

Get the value of the contained SpecificationIDType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained SpecificationIDType object or null