com.tsgrp.opencontent.universal.action.executer

Class ExportSearchResultsViaEmailActionExecuter

java.lang.Object

com.tsgrp.opencontent.core.action.ItemExecuterAbstractBase

com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

com.tsgrp.opencontent.universal.action.executer.ExportSearchResultsActionExecuter

com.tsgrp.opencontent.universal.action.executer.ExportSearchResultsViaEmailActionExecuter

All Implemented Interfaces:

ActionExecuter, ItemExecuter

public class ExportSearchResultsViaEmailActionExecuter
extends ExportSearchResultsActionExecuter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	emailSubject
protected java.lang.String	emailTemplateName

Fields inherited from class com.tsgrp.opencontent.universal.action.executer.ExportSearchResultsActionExecuter

fileExtension, LINK_TO_DOCUMENT_lABEL, URL_PROP

Fields inherited from class com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

group, groupedConditionEvaluatorList, indexImage, nonRequiredConditionEvaluatorList, requiredConditionEvaluatorList

Constructor Summary

Constructors

Constructor and Description
ExportSearchResultsViaEmailActionExecuter()

Method Summary

Modifier and Type	Method and Description
protected void	addMandatoryParameters(java.util.List<java.lang.String> mandatoryProperties) A hook method for actions to add mandatory parameters to the provided list.
protected void	createExcelWorkbookForEmail(java.lang.String ticket, java.lang.String toAddress, java.util.Map<java.lang.String,java.lang.Object> queryParams, java.lang.String excelName, java.util.List<java.lang.String> sortFields, java.util.List<java.lang.String> fieldLabels, java.util.List<java.lang.String> objectIds, java.util.Map<java.lang.String,java.lang.String> objectUrlMap, java.lang.String dateFormat)
void	executeImpl(java.lang.String ticket, Action action) The implementation of the action.
protected java.io.ByteArrayOutputStream	getExcelWorkbookStreamUsingQueryParms(java.lang.String ticket, OCQuery query, java.lang.String excelName, java.util.List<java.lang.String> sortFields, java.util.List<java.lang.String> fieldLabels, java.util.Map<java.lang.String,java.lang.String> objectUrlMap, java.lang.String dateFormat)
void	setEmailSubject(java.lang.String emailSubject)
void	setEmailTemplateName(java.lang.String emailTemplateName)
protected java.util.Map<java.lang.String,java.lang.Object>	setupEmailModel()

Methods inherited from class com.tsgrp.opencontent.universal.action.executer.ExportSearchResultsActionExecuter

createExcelWorkbookForDownload, createWbSections, getExcelWorkbookStream, setFileExtension

Methods inherited from class com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

evaluateAndExecute, execute, getActionDefinition, getDescription, getGroupedConditionEvaluatorList, getIndexImage, getNonRequiredConditionEvaluatorList, getRequiredConditionEvaluatorList, getShouldPoolAction, isGroup, setActionExecutionThreadManager, setDescription, setGroup, setGroupedConditionEvaluatorList, setIndexImage, setNonRequiredConditionEvaluatorList, setRequiredConditionEvaluatorList, setShouldPoolAction

Methods inherited from class com.tsgrp.opencontent.core.action.ItemExecuterAbstractBase

checkParameters

Methods inherited from class java.lang.Object

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

Field Detail

emailSubject

protected java.lang.String emailSubject

emailTemplateName

protected java.lang.String emailTemplateName

Constructor Detail

ExportSearchResultsViaEmailActionExecuter

public ExportSearchResultsViaEmailActionExecuter()

Method Detail

setEmailSubject

public void setEmailSubject(java.lang.String emailSubject)

setEmailTemplateName

public void setEmailTemplateName(java.lang.String emailTemplateName)

addMandatoryParameters

protected void addMandatoryParameters(java.util.List<java.lang.String> mandatoryProperties)

Description copied from class: AbstractActionExecuter

A hook method for actions to add mandatory parameters to the provided list. If a specified parameter is not present when the action executer is invoked, an error will be thrown.

Overrides:

addMandatoryParameters in class ExportSearchResultsActionExecuter

Parameters:

mandatoryProperties - a list of mandatory parameters that must be provided to the action executer when executed.

executeImpl

public void executeImpl(java.lang.String ticket,
                        Action action)

Description copied from interface: ActionExecuter

The implementation of the action.

Specified by:

executeImpl in interface ActionExecuter

Overrides:

executeImpl in class ExportSearchResultsActionExecuter

Parameters:

ticket - a valid OC ticket.

action - the action object containing the parameters sent to the action for execution.

See Also:

ActionExecuter.executeImpl(String, Action)

createExcelWorkbookForEmail

protected void createExcelWorkbookForEmail(java.lang.String ticket,
                                           java.lang.String toAddress,
                                           java.util.Map<java.lang.String,java.lang.Object> queryParams,
                                           java.lang.String excelName,
                                           java.util.List<java.lang.String> sortFields,
                                           java.util.List<java.lang.String> fieldLabels,
                                           java.util.List<java.lang.String> objectIds,
                                           java.util.Map<java.lang.String,java.lang.String> objectUrlMap,
                                           java.lang.String dateFormat)

getExcelWorkbookStreamUsingQueryParms

protected java.io.ByteArrayOutputStream getExcelWorkbookStreamUsingQueryParms(java.lang.String ticket,
                                                                              OCQuery query,
                                                                              java.lang.String excelName,
                                                                              java.util.List<java.lang.String> sortFields,
                                                                              java.util.List<java.lang.String> fieldLabels,
                                                                              java.util.Map<java.lang.String,java.lang.String> objectUrlMap,
                                                                              java.lang.String dateFormat)

setupEmailModel

protected java.util.Map<java.lang.String,java.lang.Object> setupEmailModel()