oracle.apps.fnd.applcp.srs.view.backing.output
Class OutputDocument

java.lang.Object
  oracle.apps.fnd.applcp.srs.view.backing.output.OutputDocument

All Implemented Interfaces:

IOutputDocument

public class OutputDocument
extends java.lang.Object
implements IOutputDocument

Constructor Summary

OutputDocument()

Method Summary

void	addDestination(IOutputDestination destination, java.util.List<java.lang.String> a_outputFMGList)
void	addEmailDestination(java.util.List<javax.faces.model.SelectItem> a_emailServerList, java.util.List<java.lang.String> a_outputFMGList)
void	addEmailDestination(java.util.List<javax.faces.model.SelectItem> a_emailServerList, java.lang.String a_emailToAddress, java.util.List<java.lang.String> a_outputFMGList)
void	addFaxDestination(java.util.List<javax.faces.model.SelectItem> a_faxServerList, java.util.List<java.lang.String> a_outputFMGList)
void	addFormat(java.lang.String label, java.lang.String value)
void	addFTPDestination(java.util.List<javax.faces.model.SelectItem> a_ftpServerList, java.util.List<java.lang.String> a_outputFMGList)
void	addLocale(java.lang.String label, java.lang.String value)
void	addPrinterDestination(java.util.List<javax.faces.model.SelectItem> a_printerList, java.util.List<java.lang.String> a_outputFMGList)
void	addPrinterDestination(java.util.List<javax.faces.model.SelectItem> a_printerList, java.lang.String a_selectedPrinter) Overload this method for use by the RequestHeaderDetails class, which doesn't have access to the output FMGs list.
void	addPrinterDestination(java.util.List<javax.faces.model.SelectItem> a_printerList, java.lang.String a_selectedPrinter, java.util.List<java.lang.String> a_outputFMGList)
void	addWebFolderDestination(java.util.List<javax.faces.model.SelectItem> a_folderServerList, java.util.List<java.lang.String> a_outputFMGList)
void	copyDestinations(java.util.List<IOutputDestination> a_listFrom) This method is to copy over the list of destinations from one document to another.
boolean	equals(java.lang.Object obj)
java.util.List<IOutputDestination>	getDestinationList()
java.lang.String	getFMG()
java.lang.String	getFormat()
java.util.List<javax.faces.model.SelectItem>	getFormatList()
java.lang.String	getLocale()
java.util.List<javax.faces.model.SelectItem>	getLocaleList()
java.lang.String	getName()
java.lang.String	getTemplateID()
java.lang.String	getTemplateType()
java.lang.String	getTemplateURL()
int	hashCode()
void	initializeDocument() Initialize the document with all options that can be selectable.
boolean	isEmailMe()
void	removeAllDestinations()
void	removeDestination(int destinationId)
void	removeDestination(IOutputDestination destination)
void	removeEmailDestination(java.lang.String a_emailToAddress) This method will remove all the added email destinations that match the given recipient address.
void	removePrinterDestination(java.lang.String a_printerName) This is a utility method to remove all the added printer destinations having the same printer name as the one provided in the argument of this method.
void	setDefaultFormat(java.lang.String a_defFormat) This method would set the default template format to be displayed on the drop down in the UI.
void	setDestinationList(java.util.List<IOutputDestination> a_destinationList)
void	setEmailMe(boolean a_emailMe)
void	setFMG(java.lang.String a_FMG)
void	setFormat(java.lang.String a_format)
void	setFormatList(java.util.List<javax.faces.model.SelectItem> a_formatList)
void	setLocale(java.lang.String a_locale)
void	setLocaleList(java.util.List<javax.faces.model.SelectItem> a_localeList)
void	setLocaleStringList(java.util.List<java.lang.String> a_localeList)
void	setName(java.lang.String m_name)
void	setTemplateID(java.lang.String a_templateID)
void	setTemplateType(java.lang.String a_templateType)
void	setTemplateURL(java.lang.String a_templateURL)
java.lang.String	toString()
void	updatePrinterDestination(java.util.List<javax.faces.model.SelectItem> a_printerList, java.lang.String a_oldPrinterName, java.lang.String a_selectedPrinter, java.util.List<java.lang.String> a_outputFMGList) This methodf will be used by the basic mode to update the printer name in case the user selects another printer name

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OutputDocument

public OutputDocument()

Method Detail

setName

public void setName(java.lang.String m_name)

getName

public java.lang.String getName()

Specified by:

getName in interface IOutputDocument

setFormat

public void setFormat(java.lang.String a_format)

getFormat

public java.lang.String getFormat()

Specified by:

getFormat in interface IOutputDocument

setLocale

public void setLocale(java.lang.String a_locale)

getLocale

public java.lang.String getLocale()

Specified by:

getLocale in interface IOutputDocument

setEmailMe

public void setEmailMe(boolean a_emailMe)

isEmailMe

public boolean isEmailMe()

Specified by:

isEmailMe in interface IOutputDocument

setDestinationList

public void setDestinationList(java.util.List<IOutputDestination> a_destinationList)

getDestinationList

public java.util.List<IOutputDestination> getDestinationList()

Specified by:

getDestinationList in interface IOutputDocument

addDestination

public void addDestination(IOutputDestination destination,
                           java.util.List<java.lang.String> a_outputFMGList)

removeAllDestinations

public void removeAllDestinations()

removeDestination

public void removeDestination(IOutputDestination destination)

removeDestination

public void removeDestination(int destinationId)

removePrinterDestination

public void removePrinterDestination(java.lang.String a_printerName)

This is a utility method to remove all the added printer destinations having the same printer name as the one provided in the argument of this method. All added printer destinations having the same printer name as the one given here would be removed from the list of destinations. Typically this method would be used in the basic mode of the SRS UI.

Parameters:

a_printerName - The name of the printer which is to be removed from the destination list for this document.

removeEmailDestination

public void removeEmailDestination(java.lang.String a_emailToAddress)

This method will remove all the added email destinations that match the given recipient address.

Parameters:

a_emailToAddress - The recipient address to be removed.

initializeDocument

public void initializeDocument()

Initialize the document with all options that can be selectable. Most of these will come from the applcp_pp_actions table in the fusion schema.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

addPrinterDestination

public void addPrinterDestination(java.util.List<javax.faces.model.SelectItem> a_printerList,
                                  java.util.List<java.lang.String> a_outputFMGList)

addEmailDestination

public void addEmailDestination(java.util.List<javax.faces.model.SelectItem> a_emailServerList,
                                java.util.List<java.lang.String> a_outputFMGList)

addFaxDestination

public void addFaxDestination(java.util.List<javax.faces.model.SelectItem> a_faxServerList,
                              java.util.List<java.lang.String> a_outputFMGList)

addFTPDestination

public void addFTPDestination(java.util.List<javax.faces.model.SelectItem> a_ftpServerList,
                              java.util.List<java.lang.String> a_outputFMGList)

addWebFolderDestination

public void addWebFolderDestination(java.util.List<javax.faces.model.SelectItem> a_folderServerList,
                                    java.util.List<java.lang.String> a_outputFMGList)

addPrinterDestination

public void addPrinterDestination(java.util.List<javax.faces.model.SelectItem> a_printerList,
                                  java.lang.String a_selectedPrinter,
                                  java.util.List<java.lang.String> a_outputFMGList)

updatePrinterDestination

public void updatePrinterDestination(java.util.List<javax.faces.model.SelectItem> a_printerList,
                                     java.lang.String a_oldPrinterName,
                                     java.lang.String a_selectedPrinter,
                                     java.util.List<java.lang.String> a_outputFMGList)

This methodf will be used by the basic mode to update the printer name in case the user selects another printer name

Parameters:

a_printerList - The list of all the printers available

a_selectedPrinter - The new printer name

a_outputFMGList - The output FMG list

addPrinterDestination

public void addPrinterDestination(java.util.List<javax.faces.model.SelectItem> a_printerList,
                                  java.lang.String a_selectedPrinter)

Overload this method for use by the RequestHeaderDetails class, which doesn't have access to the output FMGs list. For them, the document FMG will be passed.

Parameters:

a_printerList -

a_selectedPrinter -

addEmailDestination

public void addEmailDestination(java.util.List<javax.faces.model.SelectItem> a_emailServerList,
                                java.lang.String a_emailToAddress,
                                java.util.List<java.lang.String> a_outputFMGList)

addLocale

public void addLocale(java.lang.String label,
                      java.lang.String value)

setLocaleStringList

public void setLocaleStringList(java.util.List<java.lang.String> a_localeList)

setLocaleList

public void setLocaleList(java.util.List<javax.faces.model.SelectItem> a_localeList)

getLocaleList

public java.util.List<javax.faces.model.SelectItem> getLocaleList()

setTemplateID

public void setTemplateID(java.lang.String a_templateID)

getTemplateID

public java.lang.String getTemplateID()

Specified by:

getTemplateID in interface IOutputDocument

setTemplateType

public void setTemplateType(java.lang.String a_templateType)

getTemplateType

public java.lang.String getTemplateType()

Specified by:

getTemplateType in interface IOutputDocument

setTemplateURL

public void setTemplateURL(java.lang.String a_templateURL)

getTemplateURL

public java.lang.String getTemplateURL()

Specified by:

getTemplateURL in interface IOutputDocument

addFormat

public void addFormat(java.lang.String label,
                      java.lang.String value)

setFormatList

public void setFormatList(java.util.List<javax.faces.model.SelectItem> a_formatList)

getFormatList

public java.util.List<javax.faces.model.SelectItem> getFormatList()

Specified by:

getFormatList in interface IOutputDocument

setDefaultFormat

public void setDefaultFormat(java.lang.String a_defFormat)

This method would set the default template format to be displayed on the drop down in the UI. If a null value is passed as argument, then the first item in the format list would be set as the default format.

Parameters:

a_defFormat - The format to be set as the default format.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setFMG

public void setFMG(java.lang.String a_FMG)

getFMG

public java.lang.String getFMG()

Specified by:

getFMG in interface IOutputDocument

copyDestinations

public void copyDestinations(java.util.List<IOutputDestination> a_listFrom)

This method is to copy over the list of destinations from one document to another. This is typically used when the user switches the template id in the output table row.

Parameters:

a_listFrom - The list from which to copy over the destination objects.