Package net.webpdf.wsclient.schema.operation

Class AttachmentType.Extract

  • Enclosing class:
    AttachmentType
    public static class AttachmentType.Extract
extends Object

    Java class for anonymous complex type

    .

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

    
 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice maxOccurs="unbounded">
         <element name="selection" type="{http://schema.webpdf.de/1.0/operation}SelectionAttachmentType"/>
       </choice>
       <attribute name="folderNameTemplate" type="{http://www.w3.org/2001/XMLSchema}string" default="page[%d]" />
       <attribute name="singleFileAsZip" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • folderNameTemplate

        protected String folderNameTemplate
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p241767_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p507843_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the template for the page folders in the returned ZIP file. "page[%d]", for example, would result in a folder called "page1" for page 1, etc.</p>

      • singleFileAsZip

        protected Boolean singleFileAsZip
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p241767_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p507843_="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 combined to a common ZIP file, even if the selection is resulting in a single attachment to be selected. You can change this behaviour by setting this option to "false". In that case, this will expect to select a single attachment, that can be returned "as is".</p>

    • Constructor Detail

      • Extract

        public Extract()

    • Method Detail

      • getSelection

        public List<SelectionAttachmentType> 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 SelectionAttachmentType

        Returns:
        The value of the selection property.

      • isSetSelection

        public boolean isSetSelection()

      • unsetSelection

        public void unsetSelection()

      • getFolderNameTemplate

        public String getFolderNameTemplate()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p241767_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p507843_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the template for the page folders in the returned ZIP file. "page[%d]", for example, would result in a folder called "page1" for page 1, etc.</p>
        Returns:
        possible object is String

      • setFolderNameTemplate

        public void setFolderNameTemplate​(String value)
        Sets the value of the folderNameTemplate property.
        Parameters:
        value - allowed object is String
        See Also:
        getFolderNameTemplate()

      • isSetFolderNameTemplate

        public boolean isSetFolderNameTemplate()

      • isSingleFileAsZip

        public boolean isSingleFileAsZip()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p241767_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p507843_="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 combined to a common ZIP file, even if the selection is resulting in a single attachment to be selected. You can change this behaviour by setting this option to "false". In that case, this will expect to select a single attachment, that can be returned "as is".</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()