Package com.helger.xhe.v10.cac

Class XHE10PayloadType

  • All Implemented Interfaces:
    com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
    @CodingStyleguideUnaware
public class XHE10PayloadType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

    Java class for PayloadType complex type.

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

    
 <complexType name="PayloadType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}ID" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}Description" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}DocumentTypeCode" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}ContentTypeCode" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}CustomizationID" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}ProfileID" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}ProfileExecutionID" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}HandlingServiceID" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}ValidationTypeCode" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}ValidationVersionID" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}InstanceEncryptionIndicator"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}InstanceEncryptionMethod" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/BasicComponents}InstanceHashValue" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/AggregateComponents}InstanceDecryptionInformationExternalReference" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/AggregateComponents}InstanceDecryptionKeyExternalReference" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/AggregateComponents}RelevantExternalReference" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://docs.oasis-open.org/bdxr/ns/XHE/1/AggregateComponents}PayloadExternalReference" minOccurs="0"/>
         <element name="PayloadContent" type="{http://docs.oasis-open.org/bdxr/ns/XHE/1/AggregateComponents}PayloadContentType" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

    This class was annotated by ph-jaxb-plugin -Xph-annotate

    This class contains methods created by ph-jaxb-plugin -Xph-equalshashcode

    This class contains methods created by ph-jaxb-plugin -Xph-tostring

    This class contains methods created by ph-jaxb-plugin -Xph-list-extension

    This class contains methods created by ph-jaxb-plugin -Xph-cloneable2

    This class contains methods created by ph-jaxb-plugin -Xph-value-extender

    See Also:
    Serialized Form

    • Constructor Detail

      • XHE10PayloadType

        public XHE10PayloadType()
        Default constructor
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender

    • Method Detail

      • getDescription

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<XHE10DescriptionType> getDescription()
        Gets the value of the description 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 Jakarta XML Binding object. This is why there is not a set method for the description property.

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

            getDescription().add(newItem);

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

        Returns:
        The value of the description property.

      • setInstanceDecryptionInformationExternalReference

        public void setInstanceDecryptionInformationExternalReference​(@Nullable
                                                              XHE10ExternalReferenceType value)
        Sets the value of the instanceDecryptionInformationExternalReference property.
        Parameters:
        value - allowed object is XHE10ExternalReferenceType

      • getRelevantExternalReference

        @Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List<XHE10ExternalReferenceType> getRelevantExternalReference()
        Gets the value of the relevantExternalReference 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 Jakarta XML Binding object. This is why there is not a set method for the relevantExternalReference property.

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

            getRelevantExternalReference().add(newItem);

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

        Returns:
        The value of the relevantExternalReference property.

      • equals

        public boolean equals​(Object o)
        Created by ph-jaxb-plugin -Xph-equalshashcode
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Created by ph-jaxb-plugin -Xph-equalshashcode
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Created by ph-jaxb-plugin -Xph-tostring
        Overrides:
        toString in class Object

      • setDescription

        public void setDescription​(@Nullable
                           List<XHE10DescriptionType> aList)
        Created by ph-jaxb-plugin -Xph-list-extension
        Parameters:
        aList - The new list member to set. May be null.

      • setRelevantExternalReference

        public void setRelevantExternalReference​(@Nullable
                                         List<XHE10ExternalReferenceType> aList)
        Created by ph-jaxb-plugin -Xph-list-extension
        Parameters:
        aList - The new list member to set. May be null.

      • hasDescriptionEntries

        public boolean hasDescriptionEntries()
        Created by ph-jaxb-plugin -Xph-list-extension
        Returns:
        true if at least one item is contained, false otherwise.

      • hasNoDescriptionEntries

        public boolean hasNoDescriptionEntries()
        Created by ph-jaxb-plugin -Xph-list-extension
        Returns:
        true if no item is contained, false otherwise.

      • getDescriptionCount

        @Nonnegative
public int getDescriptionCount()
        Created by ph-jaxb-plugin -Xph-list-extension
        Returns:
        The number of contained elements. Always ≥ 0.

      • addDescription

        public void addDescription​(@Nonnull
                           XHE10DescriptionType elem)
        Created by ph-jaxb-plugin -Xph-list-extension
        Parameters:
        elem - The element to be added. May not be null.

      • hasRelevantExternalReferenceEntries

        public boolean hasRelevantExternalReferenceEntries()
        Created by ph-jaxb-plugin -Xph-list-extension
        Returns:
        true if at least one item is contained, false otherwise.

      • hasNoRelevantExternalReferenceEntries

        public boolean hasNoRelevantExternalReferenceEntries()
        Created by ph-jaxb-plugin -Xph-list-extension
        Returns:
        true if no item is contained, false otherwise.

      • getRelevantExternalReferenceCount

        @Nonnegative
public int getRelevantExternalReferenceCount()
        Created by ph-jaxb-plugin -Xph-list-extension
        Returns:
        The number of contained elements. Always ≥ 0.

      • addRelevantExternalReference

        public void addRelevantExternalReference​(@Nonnull
                                         XHE10ExternalReferenceType elem)
        Created by ph-jaxb-plugin -Xph-list-extension
        Parameters:
        elem - The element to be added. May not be null.

      • cloneTo

        public void cloneTo​(@Nonnull
                    XHE10PayloadType ret)
        This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb-plugin -Xph-cloneable2
        Parameters:
        ret - The target object to clone to. May not be null.

      • clone

        @Nonnull
@ReturnsMutableCopy
public XHE10PayloadType clone()
        Created by ph-jaxb-plugin -Xph-cloneable2
        Specified by:
        clone in interface com.helger.commons.lang.IExplicitlyCloneable
        Overrides:
        clone in class Object
        Returns:
        The cloned object. Never null.

      • setID

        @Nonnull
public XHE10IDType setID​(@Nullable
                         String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10IDType and never null

      • setDocumentTypeCode

        @Nonnull
public XHE10DocumentTypeCodeType setDocumentTypeCode​(@Nullable
                                                     String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10DocumentTypeCodeType and never null

      • setContentTypeCode

        @Nonnull
public XHE10ContentTypeCodeType setContentTypeCode​(@Nullable
                                                   String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10ContentTypeCodeType and never null

      • setCustomizationID

        @Nonnull
public XHE10CustomizationIDType setCustomizationID​(@Nullable
                                                   String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10CustomizationIDType and never null

      • setProfileID

        @Nonnull
public XHE10ProfileIDType setProfileID​(@Nullable
                                       String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10ProfileIDType and never null

      • setProfileExecutionID

        @Nonnull
public XHE10ProfileExecutionIDType setProfileExecutionID​(@Nullable
                                                         String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10ProfileExecutionIDType and never null

      • setHandlingServiceID

        @Nonnull
public XHE10HandlingServiceIDType setHandlingServiceID​(@Nullable
                                                       String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10HandlingServiceIDType and never null

      • setValidationTypeCode

        @Nonnull
public XHE10ValidationTypeCodeType setValidationTypeCode​(@Nullable
                                                         String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10ValidationTypeCodeType and never null

      • setValidationVersionID

        @Nonnull
public XHE10ValidationVersionIDType setValidationVersionID​(@Nullable
                                                           String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10ValidationVersionIDType and never null

      • setInstanceEncryptionIndicator

        @Nonnull
public XHE10InstanceEncryptionIndicatorType setInstanceEncryptionIndicator​(boolean valueParam)
        Special setter with value of type boolean
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set.
        Returns:
        The created intermediary object of type XHE10InstanceEncryptionIndicatorType and never null

      • setInstanceEncryptionMethod

        @Nonnull
public XHE10InstanceEncryptionMethodType setInstanceEncryptionMethod​(@Nullable
                                                                     String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10InstanceEncryptionMethodType and never null

      • setInstanceHashValue

        @Nonnull
public XHE10InstanceHashValueType setInstanceHashValue​(@Nullable
                                                       String valueParam)
        Special setter with value of type String
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        valueParam - The value to be set. May be null.
        Returns:
        The created intermediary object of type XHE10InstanceHashValueType and never null

      • getIDValue

        @Nullable
public String getIDValue()
        Get the value of the contained XHE10IDType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10IDType object or null

      • getDocumentTypeCodeValue

        @Nullable
public String getDocumentTypeCodeValue()
        Get the value of the contained XHE10DocumentTypeCodeType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10DocumentTypeCodeType object or null

      • getContentTypeCodeValue

        @Nullable
public String getContentTypeCodeValue()
        Get the value of the contained XHE10ContentTypeCodeType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10ContentTypeCodeType object or null

      • getCustomizationIDValue

        @Nullable
public String getCustomizationIDValue()
        Get the value of the contained XHE10CustomizationIDType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10CustomizationIDType object or null

      • getProfileIDValue

        @Nullable
public String getProfileIDValue()
        Get the value of the contained XHE10ProfileIDType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10ProfileIDType object or null

      • getProfileExecutionIDValue

        @Nullable
public String getProfileExecutionIDValue()
        Get the value of the contained XHE10ProfileExecutionIDType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10ProfileExecutionIDType object or null

      • getHandlingServiceIDValue

        @Nullable
public String getHandlingServiceIDValue()
        Get the value of the contained XHE10HandlingServiceIDType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10HandlingServiceIDType object or null

      • getValidationTypeCodeValue

        @Nullable
public String getValidationTypeCodeValue()
        Get the value of the contained XHE10ValidationTypeCodeType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10ValidationTypeCodeType object or null

      • getValidationVersionIDValue

        @Nullable
public String getValidationVersionIDValue()
        Get the value of the contained XHE10ValidationVersionIDType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10ValidationVersionIDType object or null

      • isInstanceEncryptionIndicatorValue

        public boolean isInstanceEncryptionIndicatorValue​(boolean nullValue)
        Get the value of the contained XHE10InstanceEncryptionIndicatorType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Parameters:
        nullValue - The value to be returned, if the owning object is null
        Returns:
        Either the value of the contained XHE10InstanceEncryptionIndicatorType object or the passed nullValue

      • getInstanceEncryptionMethodValue

        @Nullable
public String getInstanceEncryptionMethodValue()
        Get the value of the contained XHE10InstanceEncryptionMethodType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10InstanceEncryptionMethodType object or null

      • getInstanceHashValueValue

        @Nullable
public String getInstanceHashValueValue()
        Get the value of the contained XHE10InstanceHashValueType object
        Note: automatically created by ph-jaxb-plugin -Xph-value-extender
        Returns:
        Either the value of the contained XHE10InstanceHashValueType object or null