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

Class MiscellaneousEventType

java.lang.Object

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

All Implemented Interfaces:

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

@CodingStyleguideUnaware
public class MiscellaneousEventType
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>Miscellaneous Event. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a miscellaneous event associated with a retail event.</ccts:Definition><ccts:ObjectClass>Miscellaneous Event</ccts:ObjectClass></ccts:Component>
 

Java class for MiscellaneousEventType complex type.

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

 <complexType name="MiscellaneousEventType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MiscellaneousEventTypeCode"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}EventLineItem" maxOccurs="unbounded"/>
       </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
MiscellaneousEventType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addEventLineItem(EventLineItemType elem) Created by ph-jaxb22-plugin -Xph-list-extension
MiscellaneousEventType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(MiscellaneousEventType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
List<EventLineItemType>	getEventLineItem() <?
EventLineItemType	getEventLineItemAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getEventLineItemCount() Created by ph-jaxb22-plugin -Xph-list-extension
MiscellaneousEventTypeCodeType	getMiscellaneousEventTypeCode() <?
String	getMiscellaneousEventTypeCodeValue() Get the value of the contained MiscellaneousEventTypeCodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
boolean	hasEventLineItemEntries() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoEventLineItemEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setEventLineItem(List<EventLineItemType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setMiscellaneousEventTypeCode(MiscellaneousEventTypeCodeType value) Sets the value of the miscellaneousEventTypeCode property.
MiscellaneousEventTypeCodeType	setMiscellaneousEventTypeCode(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

MiscellaneousEventType

public MiscellaneousEventType()

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

Method Detail

getMiscellaneousEventTypeCode

@Nullable
public MiscellaneousEventTypeCodeType getMiscellaneousEventTypeCode()

 <?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>Miscellaneous Event. Miscellaneous Event Type Code. Code</ccts:DictionaryEntryName><ccts:Definition>A code signifying the type of this miscellaneous event. Examples are: ASSORTMENT_CHARGE DISASTER FORECAST_DECREASE FORECAST_INCREASE FREIGHT_FLOW_ALLOCATION INVENTORY_POLICY_CHANGE LOCATION_CLOSING LOCATION_OPENING OTHER OUT_OF_STOCK PACKAGING_LABELING_CHANGE PRICE_DECREASE PRICE_INCREASE STORE_FORMAT_OR_PLANOGRAM_CHANGE TEST_MARKET WEATHER</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Miscellaneous Event</ccts:ObjectClass><ccts:PropertyTerm>Miscellaneous Event Type Code</ccts:PropertyTerm><ccts:RepresentationTerm>Code</ccts:RepresentationTerm><ccts:DataType>Code. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is MiscellaneousEventTypeCodeType

setMiscellaneousEventTypeCode

public void setMiscellaneousEventTypeCode(@Nullable
                                          MiscellaneousEventTypeCodeType value)

Sets the value of the miscellaneousEventTypeCode property.

Parameters:

value - allowed object is MiscellaneousEventTypeCodeType

getEventLineItem

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<EventLineItemType> getEventLineItem()

 <?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>Miscellaneous Event. Event Line Item</ccts:DictionaryEntryName><ccts:Definition>An event line item for this miscellaneous retail event.</ccts:Definition><ccts:Cardinality>1..n</ccts:Cardinality><ccts:ObjectClass>Miscellaneous Event</ccts:ObjectClass><ccts:PropertyTerm>Event Line Item</ccts:PropertyTerm><ccts:AssociatedObjectClass>Event Line Item</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Event Line Item</ccts:RepresentationTerm></ccts:Component>
 

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

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

    getEventLineItem().add(newItem);
 

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

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

setEventLineItem

public void setEventLineItem(@Nullable
                             List<EventLineItemType> aList)

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

Parameters:

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

hasEventLineItemEntries

public boolean hasEventLineItemEntries()

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

Returns:

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

hasNoEventLineItemEntries

public boolean hasNoEventLineItemEntries()

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

Returns:

true if no item is contained, false otherwise.

getEventLineItemCount

@Nonnegative
public int getEventLineItemCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getEventLineItemAtIndex

@Nullable
public EventLineItemType getEventLineItemAtIndex(@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!

addEventLineItem

public void addEventLineItem(@Nonnull
                             EventLineItemType 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
                    MiscellaneousEventType 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 MiscellaneousEventType 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.

setMiscellaneousEventTypeCode

@Nonnull
public MiscellaneousEventTypeCodeType setMiscellaneousEventTypeCode(@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 MiscellaneousEventTypeCodeType and never null

getMiscellaneousEventTypeCodeValue

@Nullable
public String getMiscellaneousEventTypeCodeValue()

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

Returns:

Either the value of the contained MiscellaneousEventTypeCodeType object or null