ReturnableAssetInstructionsType (ph-cii-d16b 2.5.0 API)

java.lang.Object
- un.unece.uncefact.data.standard.reusableaggregatebusinessinformationentity._100.ReturnableAssetInstructionsType

All Implemented Interfaces:: com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

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

Java class for ReturnableAssetInstructionsType complex type.

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

 <complexType name="ReturnableAssetInstructionsType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="MaterialID" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}IDType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="TermsAndConditionsDescription" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="TermsAndConditionsDescriptionCode" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}CodeType" minOccurs="0"/>
         <element name="DepositValueSpecifiedAmount" type="{urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100}AmountType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="DepositValueValiditySpecifiedPeriod" type="{urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100}SpecifiedPeriodType" 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

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

Constructors
Constructor and Description
`ReturnableAssetInstructionsType()` Default constructor 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`	`addDepositValueSpecifiedAmount(AmountType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`addMaterialID(IDType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`addTermsAndConditionsDescription(TextType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`ReturnableAssetInstructionsType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(ReturnableAssetInstructionsType ret)` This method clones all values from `this` to the passed object.
`boolean`	`equals(Object o)` Created by ph-jaxb22-plugin -Xph-equalshashcode
`List<AmountType>`	`getDepositValueSpecifiedAmount()` Gets the value of the depositValueSpecifiedAmount property.
`AmountType`	`getDepositValueSpecifiedAmountAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getDepositValueSpecifiedAmountCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`SpecifiedPeriodType`	`getDepositValueValiditySpecifiedPeriod()` Gets the value of the depositValueValiditySpecifiedPeriod property.
`List<IDType>`	`getMaterialID()` Gets the value of the materialID property.
`IDType`	`getMaterialIDAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getMaterialIDCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`List<TextType>`	`getTermsAndConditionsDescription()` Gets the value of the termsAndConditionsDescription property.
`TextType`	`getTermsAndConditionsDescriptionAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`CodeType`	`getTermsAndConditionsDescriptionCode()` Gets the value of the termsAndConditionsDescriptionCode property.
`String`	`getTermsAndConditionsDescriptionCodeValue()` Get the value of the contained CodeType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`int`	`getTermsAndConditionsDescriptionCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasDepositValueSpecifiedAmountEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasMaterialIDEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoDepositValueSpecifiedAmountEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoMaterialIDEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoTermsAndConditionsDescriptionEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasTermsAndConditionsDescriptionEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setDepositValueSpecifiedAmount(List<AmountType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setDepositValueValiditySpecifiedPeriod(SpecifiedPeriodType value)` Sets the value of the depositValueValiditySpecifiedPeriod property.
`void`	`setMaterialID(List<IDType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setTermsAndConditionsDescription(List<TextType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setTermsAndConditionsDescriptionCode(CodeType value)` Sets the value of the termsAndConditionsDescriptionCode property.
`CodeType`	`setTermsAndConditionsDescriptionCode(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
  - ReturnableAssetInstructionsType
```
public ReturnableAssetInstructionsType()
```
    Default constructor
    Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
  - getMaterialID
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<IDType> getMaterialID()
```
    Gets the value of the materialID 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 materialID property.
    For example, to add a new item, do as follows:
```
    getMaterialID().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list IDType
  - getTermsAndConditionsDescription
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<TextType> getTermsAndConditionsDescription()
```
    Gets the value of the termsAndConditionsDescription 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 termsAndConditionsDescription property.
    For example, to add a new item, do as follows:
```
    getTermsAndConditionsDescription().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list TextType
  - getTermsAndConditionsDescriptionCode
```
@Nullable
public CodeType getTermsAndConditionsDescriptionCode()
```
    Gets the value of the termsAndConditionsDescriptionCode property.
    
    Returns:
    
    possible object is CodeType
  - setTermsAndConditionsDescriptionCode
```
public void setTermsAndConditionsDescriptionCode(@Nullable
                                                 CodeType value)
```
    Sets the value of the termsAndConditionsDescriptionCode property.
    
    Parameters:
    
    value - allowed object is CodeType
  - getDepositValueSpecifiedAmount
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<AmountType> getDepositValueSpecifiedAmount()
```
    Gets the value of the depositValueSpecifiedAmount 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 depositValueSpecifiedAmount property.
    For example, to add a new item, do as follows:
```
    getDepositValueSpecifiedAmount().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AmountType
  - getDepositValueValiditySpecifiedPeriod
```
@Nullable
public SpecifiedPeriodType getDepositValueValiditySpecifiedPeriod()
```
    Gets the value of the depositValueValiditySpecifiedPeriod property.
    
    Returns:
    
    possible object is SpecifiedPeriodType
  - setDepositValueValiditySpecifiedPeriod
```
public void setDepositValueValiditySpecifiedPeriod(@Nullable
                                                   SpecifiedPeriodType value)
```
    Sets the value of the depositValueValiditySpecifiedPeriod property.
    
    Parameters:
    
    value - allowed object is SpecifiedPeriodType
  - 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
  - setMaterialID
```
public void setMaterialID(@Nullable
                          List<IDType> aList)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    aList - The new list member to set. May be null.
  - setTermsAndConditionsDescription
```
public void setTermsAndConditionsDescription(@Nullable
                                             List<TextType> aList)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    aList - The new list member to set. May be null.
  - setDepositValueSpecifiedAmount
```
public void setDepositValueSpecifiedAmount(@Nullable
                                           List<AmountType> aList)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    aList - The new list member to set. May be null.
  - hasMaterialIDEntries
```
public boolean hasMaterialIDEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if at least one item is contained, false otherwise.
  - hasNoMaterialIDEntries
```
public boolean hasNoMaterialIDEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if no item is contained, false otherwise.
  - getMaterialIDCount
```
@Nonnegative
public int getMaterialIDCount()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    The number of contained elements. Always ≥ 0.
  - getMaterialIDAtIndex
```
@Nullable
public IDType getMaterialIDAtIndex(@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!
  - addMaterialID
```
public void addMaterialID(@Nonnull
                          IDType elem)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    elem - The element to be added. May not be null.
  - hasTermsAndConditionsDescriptionEntries
```
public boolean hasTermsAndConditionsDescriptionEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if at least one item is contained, false otherwise.
  - hasNoTermsAndConditionsDescriptionEntries
```
public boolean hasNoTermsAndConditionsDescriptionEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if no item is contained, false otherwise.
  - getTermsAndConditionsDescriptionCount
```
@Nonnegative
public int getTermsAndConditionsDescriptionCount()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    The number of contained elements. Always ≥ 0.
  - getTermsAndConditionsDescriptionAtIndex
```
@Nullable
public TextType getTermsAndConditionsDescriptionAtIndex(@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!
  - addTermsAndConditionsDescription
```
public void addTermsAndConditionsDescription(@Nonnull
                                             TextType elem)
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Parameters:
    
    elem - The element to be added. May not be null.
  - hasDepositValueSpecifiedAmountEntries
```
public boolean hasDepositValueSpecifiedAmountEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if at least one item is contained, false otherwise.
  - hasNoDepositValueSpecifiedAmountEntries
```
public boolean hasNoDepositValueSpecifiedAmountEntries()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    true if no item is contained, false otherwise.
  - getDepositValueSpecifiedAmountCount
```
@Nonnegative
public int getDepositValueSpecifiedAmountCount()
```
    Created by ph-jaxb22-plugin -Xph-list-extension
    
    Returns:
    
    The number of contained elements. Always ≥ 0.
  - getDepositValueSpecifiedAmountAtIndex
```
@Nullable
public AmountType getDepositValueSpecifiedAmountAtIndex(@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!
  - addDepositValueSpecifiedAmount
```
public void addDepositValueSpecifiedAmount(@Nonnull
                                           AmountType 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
                    ReturnableAssetInstructionsType 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 ReturnableAssetInstructionsType 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.
  - setTermsAndConditionsDescriptionCode
```
@Nonnull
public CodeType setTermsAndConditionsDescriptionCode(@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 CodeType and never null
  - getTermsAndConditionsDescriptionCodeValue
```
@Nullable
public String getTermsAndConditionsDescriptionCodeValue()
```
    Get the value of the contained CodeType object
    Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
    
    Returns:
    
    Either the value of the contained CodeType object or null

Class ReturnableAssetInstructionsType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReturnableAssetInstructionsType

Method Detail

getMaterialID

getTermsAndConditionsDescription

getTermsAndConditionsDescriptionCode

setTermsAndConditionsDescriptionCode

getDepositValueSpecifiedAmount

getDepositValueValiditySpecifiedPeriod

setDepositValueValiditySpecifiedPeriod

equals

hashCode

toString

setMaterialID

setTermsAndConditionsDescription

setDepositValueSpecifiedAmount

hasMaterialIDEntries

hasNoMaterialIDEntries

getMaterialIDCount

getMaterialIDAtIndex

addMaterialID

hasTermsAndConditionsDescriptionEntries

hasNoTermsAndConditionsDescriptionEntries

getTermsAndConditionsDescriptionCount

getTermsAndConditionsDescriptionAtIndex

addTermsAndConditionsDescription

hasDepositValueSpecifiedAmountEntries

hasNoDepositValueSpecifiedAmountEntries

getDepositValueSpecifiedAmountCount

getDepositValueSpecifiedAmountAtIndex

addDepositValueSpecifiedAmount

cloneTo

clone

setTermsAndConditionsDescriptionCode

getTermsAndConditionsDescriptionCodeValue