Package com.adobe.aemds.guide.addon.dor

Class DoROptions

  • public final class DoROptions
extends java.lang.Object
    This class defines the information pertaining to the Document of Record Service. The options defined by this class will be used for the conversion of Adaptive form to document of record
    Since:
    6.3

    • Constructor Summary

      Constructors 
      Constructor Description
      DoROptions()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getData()
      Returns the data which is to be processed.
      java.util.List<FileAttachmentWrapper> getFileAttachments()
      This method will return the list of attachments FileAttachmentWrapper to be used during document of record generation
      Resource getFormResource()
      Returns the adaptive form container or form asset or CQ Page resource which is to be processed to generate document of record
      boolean getIncludeAttachments()
      The boolean flag which indicates whether any attachments have to be included during generation of document of record
      java.util.Locale getLocale()
      This method will return the Locale object which will return the language used.
      java.lang.String getUserXci()
      This method will return user specified global XCI path
      boolean isNonInteractive()
      The boolean flag which requests the DoR service to generate non interactive pdf This is false by default, which allows the DoR service to decide which kind of pdf to generate
      void setData​(java.lang.String data)
      This method will set the data that will be used for processing to generate document of record
      void setFileAttachments​(java.util.List<FileAttachmentWrapper> attachments)
      This method will set the list of attachments FileAttachmentWrapper to be included in the document of record
      void setFormResource​(Resource afResource)
      This will set the Resource of the path of the Adaptive Form which is to be processed.
      void setIncludeAttachments​(boolean includeAttachments)
      Sets the flag to include attachment during document of record generation
      void setLocale​(java.util.Locale locale)
      This method will set the locale Object with the object passed.
      void setNonInteractive​(boolean nonInteractive)
      Sets the flag to always get non-interactive DoR from DoR service.
      void setUserXci​(java.lang.String userXci)
      This method will set user specified global XCI path

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DoROptions

        public DoROptions()

    • Method Detail

      • getLocale

        public java.util.Locale getLocale()
        This method will return the Locale object which will return the language used.
        Returns:
        Locale

      • setLocale

        public void setLocale​(java.util.Locale locale)
        This method will set the locale Object with the object passed.
        Parameters:
        locale - locale object

      • getData

        public java.lang.String getData()
        Returns the data which is to be processed.
        Returns:
        data string representing the data

      • setData

        public void setData​(java.lang.String data)
        This method will set the data that will be used for processing to generate document of record
        Parameters:
        data - The data which needs to be processed.

      • getFormResource

        public Resource getFormResource()
        Returns the adaptive form container or form asset or CQ Page resource which is to be processed to generate document of record
        Returns:
        sling resource of the adaptive form container

      • setFormResource

        public void setFormResource​(Resource afResource)
        This will set the Resource of the path of the Adaptive Form which is to be processed. It could be guideContainer Resource or Form Asset Resource or CQ Page resource.
        Parameters:
        afResource - resource of the location of the Adaptive Form.

      • getIncludeAttachments

        public boolean getIncludeAttachments()
        The boolean flag which indicates whether any attachments have to be included during generation of document of record
        Returns:
        The boolean flag indicating whether to include attachments or not.

      • setIncludeAttachments

        public void setIncludeAttachments​(boolean includeAttachments)
        Sets the flag to include attachment during document of record generation
        Parameters:
        includeAttachments - Boolean flag to attach attachments or not.

      • isNonInteractive

        public boolean isNonInteractive()
        The boolean flag which requests the DoR service to generate non interactive pdf This is false by default, which allows the DoR service to decide which kind of pdf to generate
        Returns:
        The boolean flag for requesting non interactive pdf always

      • setNonInteractive

        public void setNonInteractive​(boolean nonInteractive)
        Sets the flag to always get non-interactive DoR from DoR service. Note that setting this value to false, does not guarantee the returned pdf will be interactive Check DoRResult.isNonInteractive() to be sure
        Parameters:
        nonInteractive - Boolean flag to request non interactive pdf.

      • setFileAttachments

        public void setFileAttachments​(java.util.List<FileAttachmentWrapper> attachments)
        This method will set the list of attachments FileAttachmentWrapper to be included in the document of record
        Parameters:
        attachments - List of attachment of files.

      • getFileAttachments

        public java.util.List<FileAttachmentWrapper> getFileAttachments()
        This method will return the list of attachments FileAttachmentWrapper to be used during document of record generation
        Returns:
        The list of attachments.

      • getUserXci

        public java.lang.String getUserXci()
        This method will return user specified global XCI path
        Returns:
        user XCI content.

      • setUserXci

        public void setUserXci​(java.lang.String userXci)
        This method will set user specified global XCI path