EncryptionDataType (ph-ubl22 6.7.0 API)

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

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
```
@CodingStyleguideUnaware
public class EncryptionDataType
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>Encryption Data. Details</ccts:DictionaryEntryName><ccts:Definition>Details of an encryption process</ccts:Definition><ccts:ObjectClass>Encryption Data</ccts:ObjectClass></ccts:Component> </pre> Java class for EncryptionDataType complex type. The following schema fragment specifies the expected content contained within this class. <pre> <complexType name="EncryptionDataType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MessageFormat"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}EncryptionCertificateAttachment" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}EncryptionCertificatePathChain" maxOccurs="unbounded" minOccurs="0"/> <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}EncryptionSymmetricAlgorithm" maxOccurs="unbounded" 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

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

Constructors
Constructor and Description
`EncryptionDataType()` 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`	`addEncryptionCertificatePathChain(EncryptionCertificatePathChainType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`addEncryptionSymmetricAlgorithm(EncryptionSymmetricAlgorithmType elem)` Created by ph-jaxb22-plugin -Xph-list-extension
`EncryptionDataType`	`clone()` Created by ph-jaxb22-plugin -Xph-cloneable2
`void`	`cloneTo(EncryptionDataType 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
`AttachmentType`	`getEncryptionCertificateAttachment()` <pre> <?
`List<EncryptionCertificatePathChainType>`	`getEncryptionCertificatePathChain()` <pre> <?
`EncryptionCertificatePathChainType`	`getEncryptionCertificatePathChainAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getEncryptionCertificatePathChainCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`List<EncryptionSymmetricAlgorithmType>`	`getEncryptionSymmetricAlgorithm()` <pre> <?
`EncryptionSymmetricAlgorithmType`	`getEncryptionSymmetricAlgorithmAtIndex(int index)` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`getEncryptionSymmetricAlgorithmCount()` Created by ph-jaxb22-plugin -Xph-list-extension
`MessageFormatType`	`getMessageFormat()` <pre> <?
`String`	`getMessageFormatValue()` Get the value of the contained MessageFormatType object<br> Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
`boolean`	`hasEncryptionCertificatePathChainEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasEncryptionSymmetricAlgorithmEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`int`	`hashCode()` Created by ph-jaxb22-plugin -Xph-equalshashcode
`boolean`	`hasNoEncryptionCertificatePathChainEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`boolean`	`hasNoEncryptionSymmetricAlgorithmEntries()` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setEncryptionCertificateAttachment(AttachmentType value)` Sets the value of the encryptionCertificateAttachment property.
`void`	`setEncryptionCertificatePathChain(List<EncryptionCertificatePathChainType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setEncryptionSymmetricAlgorithm(List<EncryptionSymmetricAlgorithmType> aList)` Created by ph-jaxb22-plugin -Xph-list-extension
`void`	`setMessageFormat(MessageFormatType value)` Sets the value of the messageFormat property.
`MessageFormatType`	`setMessageFormat(String valueParam)` Special setter with value of type String<br> 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
 - EncryptionDataType
```
public EncryptionDataType()
```
 Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
- Method Detail
 - getMessageFormat
```
@Nullable
public MessageFormatType getMessageFormat()
```
 <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>Encryption Data. Message Format. Text</ccts:DictionaryEntryName><ccts:Definition>The format of the encrypted message.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Encryption Data</ccts:ObjectClass><ccts:PropertyTerm>Message Format</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component> </pre>
 
 Returns:
 
 possible object is MessageFormatType
 - setMessageFormat
```
public void setMessageFormat(@Nullable
 MessageFormatType value)
```
 Sets the value of the messageFormat property.
 
 Parameters:
 
 value - allowed object is MessageFormatType
 - getEncryptionCertificateAttachment
```
@Nullable
public AttachmentType getEncryptionCertificateAttachment()
```
 <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>Encryption Data. Encryption Certificate_ Attachment. Attachment</ccts:DictionaryEntryName><ccts:Definition>A reference to the certificate used in the encryption process.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Encryption Data</ccts:ObjectClass><ccts:PropertyTermQualifier>Encryption Certificate</ccts:PropertyTermQualifier><ccts:PropertyTerm>Attachment</ccts:PropertyTerm><ccts:AssociatedObjectClass>Attachment</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Attachment</ccts:RepresentationTerm></ccts:Component> </pre>
 
 Returns:
 
 possible object is AttachmentType
 - setEncryptionCertificateAttachment
```
public void setEncryptionCertificateAttachment(@Nullable
 AttachmentType value)
```
 Sets the value of the encryptionCertificateAttachment property.
 
 Parameters:
 
 value - allowed object is AttachmentType
 - getEncryptionCertificatePathChain
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<EncryptionCertificatePathChainType> getEncryptionCertificatePathChain()
```
 <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>Encryption Data. Encryption Certificate Path Chain</ccts:DictionaryEntryName><ccts:Definition>A reference to the path chain defined for the encryption process.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Encryption Data</ccts:ObjectClass><ccts:PropertyTerm>Encryption Certificate Path Chain</ccts:PropertyTerm><ccts:AssociatedObjectClass>Encryption Certificate Path Chain</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Encryption Certificate Path Chain</ccts:RepresentationTerm></ccts:Component> </pre> Gets the value of the encryptionCertificatePathChain 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 encryptionCertificatePathChain property. For example, to add a new item, do as follows: <pre> getEncryptionCertificatePathChain().add(newItem); </pre> Objects of the following type(s) are allowed in the list EncryptionCertificatePathChainType
 - getEncryptionSymmetricAlgorithm
```
@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<EncryptionSymmetricAlgorithmType> getEncryptionSymmetricAlgorithm()
```
 <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>Encryption Data. Encryption Symmetric Algorithm</ccts:DictionaryEntryName><ccts:Definition>A reference to the symmetric algorithm used for the encryption process.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Encryption Data</ccts:ObjectClass><ccts:PropertyTerm>Encryption Symmetric Algorithm</ccts:PropertyTerm><ccts:AssociatedObjectClass>Encryption Symmetric Algorithm</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Encryption Symmetric Algorithm</ccts:RepresentationTerm></ccts:Component> </pre> Gets the value of the encryptionSymmetricAlgorithm 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 encryptionSymmetricAlgorithm property. For example, to add a new item, do as follows: <pre> getEncryptionSymmetricAlgorithm().add(newItem); </pre> Objects of the following type(s) are allowed in the list EncryptionSymmetricAlgorithmType
 - 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
 - setEncryptionCertificatePathChain
```
public void setEncryptionCertificatePathChain(@Nullable
 List<EncryptionCertificatePathChainType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - setEncryptionSymmetricAlgorithm
```
public void setEncryptionSymmetricAlgorithm(@Nullable
 List<EncryptionSymmetricAlgorithmType> aList)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 aList - The new list member to set. May be <code>null</code>.
 - hasEncryptionCertificatePathChainEntries
```
public boolean hasEncryptionCertificatePathChainEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoEncryptionCertificatePathChainEntries
```
public boolean hasNoEncryptionCertificatePathChainEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getEncryptionCertificatePathChainCount
```
@Nonnegative
public int getEncryptionCertificatePathChainCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getEncryptionCertificatePathChainAtIndex
```
@Nullable
public EncryptionCertificatePathChainType getEncryptionCertificatePathChainAtIndex(@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!
 - addEncryptionCertificatePathChain
```
public void addEncryptionCertificatePathChain(@Nonnull
 EncryptionCertificatePathChainType elem)
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Parameters:
 
 elem - The element to be added. May not be <code>null</code>.
 - hasEncryptionSymmetricAlgorithmEntries
```
public boolean hasEncryptionSymmetricAlgorithmEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if at least one item is contained, <code>false</code> otherwise.
 - hasNoEncryptionSymmetricAlgorithmEntries
```
public boolean hasNoEncryptionSymmetricAlgorithmEntries()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 <code>true</code> if no item is contained, <code>false</code> otherwise.
 - getEncryptionSymmetricAlgorithmCount
```
@Nonnegative
public int getEncryptionSymmetricAlgorithmCount()
```
 Created by ph-jaxb22-plugin -Xph-list-extension
 
 Returns:
 
 The number of contained elements. Always ≥ 0.
 - getEncryptionSymmetricAlgorithmAtIndex
```
@Nullable
public EncryptionSymmetricAlgorithmType getEncryptionSymmetricAlgorithmAtIndex(@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!
 - addEncryptionSymmetricAlgorithm
```
public void addEncryptionSymmetricAlgorithm(@Nonnull
 EncryptionSymmetricAlgorithmType 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
 EncryptionDataType 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 EncryptionDataType 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>.
 - setMessageFormat
```
@Nonnull
public MessageFormatType setMessageFormat(@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 MessageFormatType and never <code>null</code>
 - getMessageFormatValue
```
@Nullable
public String getMessageFormatValue()
```
 Get the value of the contained MessageFormatType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
 
 Returns:
 
 Either the value of the contained MessageFormatType object or <code>null</code>

Class EncryptionDataType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EncryptionDataType

Method Detail

getMessageFormat

setMessageFormat

getEncryptionCertificateAttachment

setEncryptionCertificateAttachment

getEncryptionCertificatePathChain

getEncryptionSymmetricAlgorithm

equals

hashCode

toString

setEncryptionCertificatePathChain

setEncryptionSymmetricAlgorithm

hasEncryptionCertificatePathChainEntries

hasNoEncryptionCertificatePathChainEntries

getEncryptionCertificatePathChainCount

getEncryptionCertificatePathChainAtIndex

addEncryptionCertificatePathChain

hasEncryptionSymmetricAlgorithmEntries

hasNoEncryptionSymmetricAlgorithmEntries

getEncryptionSymmetricAlgorithmCount

getEncryptionSymmetricAlgorithmAtIndex

addEncryptionSymmetricAlgorithm

cloneTo

clone

setMessageFormat

getMessageFormatValue