com.adobe.aemds.guide.addon.dor

Class DoROptions

java.lang.Object

com.adobe.aemds.guide.addon.dor.DoROptions

public final class DoROptions
extends 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 and Description
DoROptions()

Method Summary

Modifier and Type	Method and Description
String	getData() Returns the data which is to be processed.
List<FileAttachmentWrapper>	getFileAttachments() This method will return the list of attachments FileAttachmentWrapper to be used during document of record generation
org.apache.sling.api.resource.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
Locale	getLocale() This method will return the Locale object which will return the language used.
String	getUserXci() This method will return user specified global XCI path
void	setData(String data) This method will set the data that will be used for processing to generate document of record
void	setFileAttachments(List<FileAttachmentWrapper> attachments) This method will set the list of attachments FileAttachmentWrapper to be included in the document of record
void	setFormResource(org.apache.sling.api.resource.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(Locale locale) This method will set the locale Object with the object passed.
void	setUserXci(String userXci) This method will set user specified global XCI path

Constructor Detail

DoROptions

public DoROptions()

Method Detail

getLocale

public Locale getLocale()

This method will return the Locale object which will return the language used.

Returns:

Locale

setLocale

public void setLocale(Locale locale)

This method will set the locale Object with the object passed.

Parameters:

locale - locale object

getData

public String getData()

Returns the data which is to be processed.

Returns:

data string representing the data

setData

public void setData(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 org.apache.sling.api.resource.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(org.apache.sling.api.resource.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.

setFileAttachments

public void setFileAttachments(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 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 String getUserXci()

This method will return user specified global XCI path

Returns:

user XCI content.

setUserXci

public void setUserXci(String userXci)

This method will set user specified global XCI path