Package net.webpdf.wsclient.schema.operation

Class PortfolioExtractType

  • public class PortfolioExtractType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p186898_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p243_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p722845_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Extracts one or more documents from the portfolio. The result will be returned as a ZIP document. The ZIP document will not only contain the extracted files, but will also reproduce the folder structure in which the documents were found.</p>

    Java class for PortfolioExtractType complex type

    .

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

    
 <complexType name="PortfolioExtractType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice maxOccurs="unbounded">
         <element name="selection" type="{http://schema.webpdf.de/1.0/operation}PortfolioSelectionType"/>
       </choice>
       <attribute name="singleFileAsZip" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • singleFileAsZip

        protected Boolean singleFileAsZip
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p186898_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p243_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p722845_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The returned attachments will be generated as a ZIP file even if selection is used to select only one single file. You can change this behaviour by setting this option to "false". In this case, the file will not be zipped, and will instead be returned directly as is. However, this will only work if selection has been used to select one file and one file only.</p>

    • Constructor Detail

      • PortfolioExtractType

        public PortfolioExtractType()

    • Method Detail

      • getSelection

        public List<PortfolioSelectionType> getSelection()
        Gets the value of the selection 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 selection property.

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

         getSelection().add(newItem);

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

        Returns:
        The value of the selection property.

      • isSetSelection

        public boolean isSetSelection()

      • unsetSelection

        public void unsetSelection()

      • isSingleFileAsZip

        public boolean isSingleFileAsZip()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p186898_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:p243_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p722845_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The returned attachments will be generated as a ZIP file even if selection is used to select only one single file. You can change this behaviour by setting this option to "false". In this case, the file will not be zipped, and will instead be returned directly as is. However, this will only work if selection has been used to select one file and one file only.</p>
        Returns:
        possible object is Boolean

      • setSingleFileAsZip

        public void setSingleFileAsZip​(boolean value)
        Sets the value of the singleFileAsZip property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isSingleFileAsZip()

      • isSetSingleFileAsZip

        public boolean isSetSingleFileAsZip()

      • unsetSingleFileAsZip

        public void unsetSingleFileAsZip()