com.actuate.activeportal.forms
Class SubmitJobActionForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by com.actuate.activeportal.forms.BaseActionForm
          extended by com.actuate.activeportal.forms.JobActionForm
              extended by com.actuate.activeportal.forms.SubmitJobActionForm
All Implemented Interfaces:
java.io.Serializable

public class SubmitJobActionForm
extends JobActionForm

This is a session form that contains the information for submitting a job.

See Also:
Serialized Form

Field Summary
static int PRIORITY_HI
           
static int PRIORITY_LOW
           
static int PRIORITY_MED
           
static int PRIORITY_OTHER
           
static java.lang.String STR_PRIORITY_HI
           
static java.lang.String STR_PRIORITY_LOW
           
static java.lang.String STR_PRIORITY_MED
           
static java.lang.String STR_PRIORITY_OTHER
           
 
Fields inherited from class com.actuate.activeportal.forms.JobActionForm
recurringDayList, structureNames
 
Constructor Summary
SubmitJobActionForm()
           
 
Method Summary
 void clear()
           
 void fixUTF8()
          Converts the form properties which is in UTF-8 encoding to internal Java String.
 java.lang.String getAbsFolder()
          Returns the absFolder.
 com.actuate.activeportal.utils.AdHocParameters getAdhocControlListParameters(int index)
           
 java.lang.String getArchivePolicy()
          Returns the archivePolicy.
 java.lang.String getChangedConversionOptions()
          Get the option that was changed recently due to a cascading ParameterDefinition conversion option
 java.lang.String getChangedParamterName()
          Returns the changed parameter name.
 com.actuate.schemas.ParameterDefinition[] getChildParameterDefinitions(com.actuate.schemas.ParameterDefinition[] paramDef, java.lang.String changedName)
           
 com.actuate.activeportal.utils.AdHocParameters getConvAdhocControlListParameters(int index)
           
 java.lang.String getConversionFormat()
           
 com.actuate.schemas.ParameterDefinition[] getConvParameterDefinitions()
          Returns the parameterDefinitions.
 com.actuate.schemas.ParameterValue[] getConvParameters()
          Returns the parameters.
 com.actuate.schemas.ParameterValue getConvParameters(int index)
          Returns the parameters.
 java.lang.String getDependentFileName()
           
 java.lang.String getDependentFileType()
           
 java.lang.String getEndDate()
          Returns the endDate.
 java.lang.String getExpireAge()
          Returns the expireAge.
 java.lang.String getExpireDate()
          Returns the expireDate.
 java.lang.String getExpireTime()
          Returns the expireTime.
 java.lang.String getFolderType()
          Returns the folderType.
 java.lang.String getHeadline()
          Returns the headline.
 java.lang.String getIfExists()
          Returns the ifExists.
 java.lang.String getInputfile()
          Returns the inputfile.
 java.lang.String getInvokeSubmit()
          Returns the invokeSubmit.
 java.lang.String getIPortalID()
           
 java.lang.String getJobName()
          Returns the jobName.
 java.lang.String getJobType()
          Returns the jobType.
 java.lang.String[] getNotificationTypes()
           
 java.lang.String[] getNotifyChannelsByName()
          Returns the notifyChannelsByName.
 java.lang.String[] getNotifyGroupsByName()
          Returns the notifyGroupsByName.
 java.lang.String[] getNotifyUsersByName()
          Returns the notifyUsersByName.
 java.lang.String getNumVersions()
          Returns the numVersions.
 java.lang.String getOnceDate()
          Returns the onceDate.
 java.lang.String getOnceTime()
          Returns the onceTime.
 java.lang.Integer getOtherPriorityValue()
          Returns the value of the priority text box.
 java.lang.String getOutputDocumentPath()
          Returns the output document path.
 java.lang.String[] getOutputFormatTypes()
           
 java.lang.String getOutputName()
          Returns the outputName.
 java.lang.String getOutputType()
           
 java.lang.String[] getOutputTypes()
           
 com.actuate.schemas.ParameterDefinition[] getParameterDefinitions()
          Returns the parameterDefinitions.
 com.actuate.schemas.ParameterDefinition getParameterDefinitions(int index)
          Returns the parameterDefinitions.
 com.actuate.schemas.ParameterValue[] getParameters()
          Returns the parameters.
 com.actuate.schemas.ParameterValue getParameters(int index)
          Returns the parameterDefinitions.
 com.actuate.schemas.ParameterValue[] getPrecedingParameterValuesForChangedChildren(com.actuate.schemas.ParameterDefinition[] paramDef, com.actuate.schemas.ParameterValue[] paramValues, java.lang.String changedName)
          Returns the preceding parameter values for the changed parameter's child parameters.
 int getPriority()
          Returns the priority, based on the content of the radio button and text box
 int getPriorityRadioValue()
          Returns the value of the priority radio button.
 java.lang.String getRecurringDay()
          Returns the recurringDay.
 java.lang.String getRecurringTime()
          Returns the recurringTime.
 boolean getRequesterPageShown()
           
 java.util.Map getReservedParameters()
           
 java.lang.String getScheduleType()
          Returns the scheduleType.
 java.lang.String getSelectedTab()
          Returns the selectedTab.
 java.lang.String getStartDate()
          Returns the startDate.
 java.lang.String getStringKeep()
          Returns the stringKeep.
 java.lang.String getStringSaveOutput()
          Returns the stringSaveOutput.
 java.lang.String getStringUseEndDateTime()
          Returns the stringUseEndDateTime.
 java.lang.String getStringUseStartDateTime()
          Returns the stringUseStartDateTime.
 int getTotalTabs()
           
 java.lang.String getVersionName()
          Returns the versionName.
 java.lang.String getWindowName()
           
 boolean isAlreadyRetrievedParameters()
           
 boolean isArchiveBeforeDelete()
          Returns the archiveBeforeDelete.
 boolean isConversionOptionSupported()
          Determines whether conversion option is supported by querying if the Conversion ParameterDefinition is null/empty.
 boolean isKeep()
          Returns the keep.
 boolean isOutputConversionAllowed()
           
 boolean isProgressive()
          Returns the progressive.
 boolean isSaveOutput()
          Returns the saveOutput.
 boolean isUseEndDateTime()
          Returns the useEndDateTime.
 boolean isUseStartDateTime()
          Returns the useStartDateTime.
 boolean isUsingJSAPIParameterPage()
           
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
           
 void setAbsFolder(java.lang.String absFolder)
           
 void setAbsFolder(java.lang.String absFolder, boolean UTF8)
          Sets the absFolder.
 void setArchiveBeforeDelete(boolean archiveBeforeDelete)
          Sets the archiveBeforeDelete.
 void setArchivePolicy(java.lang.String archivePolicy)
          Sets the archivePolicy.
 void setChangedConversionOptions(java.lang.String option)
          Set the option that was changed due to a cascading ParameterDefinition conversion option
 void setchangedParamterName(java.lang.String paramterName)
           
 void setConversionFormat(java.lang.String conversionFormat)
           
 void setConvParameterDefinitions(com.actuate.schemas.ParameterDefinition[] parameterDefinitions)
          Sets the parameterDefinitions.
 void setConvParameters(int index, com.actuate.schemas.ParameterValue parameter)
          Sets the conversion parameter based on the specified index.
 void setConvParameters(com.actuate.schemas.ParameterValue[] parameters)
          Sets the parameters.
 void setDependentFileName(java.lang.String fileName)
           
 void setDependentFileType(java.lang.String fileType)
           
 void setEndDate(java.lang.String endDate)
          Sets the endDate.
 void setEndDateUTF(java.lang.String endDate, boolean UTF8)
          Sets the endDate.
 void setExpireAge(java.lang.String expireAge)
          Sets the expireAge.
 void setExpireDate(java.lang.String expireDate)
           
 void setExpireDate(java.lang.String expireDate, boolean UTF8)
          Sets the expireDate.
 void setExpireTime(java.lang.String expireTime)
           
 void setExpireTime(java.lang.String expireTime, boolean UTF8)
          Sets the expireTime.
 void setFolderType(java.lang.String folderType)
          Sets the folderType.
 void setHeadline(java.lang.String headline)
           
 void setHeadline(java.lang.String headline, boolean UTF8)
          Sets the headline.
 void setIfExists(java.lang.String ifExists)
          Sets the ifExists.
 void setInputfile(java.lang.String inputfile)
           
 void setInputfile(java.lang.String inputfile, boolean UTF8)
          Sets the inputfile.
 void setInvokeSubmit(java.lang.String invokeSubmit)
          Sets the invokeSubmit.
 void setIPortalID(java.lang.String parameter)
           
 void setIsAlreadyRetrievedParameter(boolean retrievedParameters)
           
 void setIsUsingJSAPIParameterPage(boolean usingJSAPIParameterPage)
           
 void setJobName(java.lang.String jobName)
          Sets the jobName.
 void setJobName(java.lang.String jobName, boolean UTF8)
          Sets the jobName.
 void setJobType(java.lang.String jobType)
          Sets the jobType.
 void setKeep(boolean keep)
          Sets the keep.
 void setNotificationTypes(java.lang.String[] notificationTypes)
           
 void setNotifyChannelsByName(java.lang.String[] notifyChannelsByName)
          Sets the notifyChannelsByName.
 void setNotifyGroupsByName(java.lang.String[] notifyGroupsByName)
          Sets the notifyGroupsByName.
 void setNotifyUsersByName(java.lang.String[] notifyUsersByName)
          Sets the notifyUsersByName.
 void setNumVersions(java.lang.String numVersions)
          Sets the numVersions.
 void setOnceDate(java.lang.String onceDate)
          Sets the onceDate.
 void setOnceDate(java.lang.String onceDate, boolean UTF8)
          Sets the onceDate.
 void setOnceTime(java.lang.String onceTime)
          Sets the onceTime.
 void setOnceTime(java.lang.String onceTime, boolean UTF8)
          Sets the onceTime.
 void setOtherPriorityValue(java.lang.Integer value)
          /** Sets the value of the priority text box
 void setOutputConversionAllowed(boolean value)
           
 void setOutputDocumentPath(java.lang.String path, boolean UTF8)
          sets the output document path.
 void setOutputName(java.lang.String outputName)
           
 void setOutputName(java.lang.String outputName, boolean UTF8)
          Sets the outputName.
 void setOutputType(java.lang.String string)
           
 void setOutputTypes(java.lang.String[] strings)
           
 void setParameterDefinitions(int index, com.actuate.schemas.ParameterDefinition parameterDefinition)
          Sets the parameterDefinition from index location.
 void setParameterDefinitions(com.actuate.schemas.ParameterDefinition[] parameterDefinitions)
          Sets the parameterDefinitions.
 void setParameters(int index, com.actuate.schemas.ParameterValue parameter)
          Sets the parameter value based on the specified index.
 void setParameters(com.actuate.schemas.ParameterValue[] parameters)
          Sets the parameters.
 void setPriority(int value)
          Sets the value of the priority, updating both the radio button and the text box
 void setPriorityRadioValue(int value)
          Sets the value of the priority radio button
 void setProgressive(boolean progressive)
          Sets the progressive.
 void setRecurringDay(java.lang.String recurringDay)
          Sets the recurringDay, the values available is in the array recurringDayList.
 void setRecurringTime(java.lang.String recurringTime)
          Sets the recurringTime.
 void setRecurringTime(java.lang.String recurringTime, boolean UTF8)
          Sets the recurringTime.
 void setRequesterPageShown(boolean requesterPageShown)
           
 void setReservedParameters(java.util.Map reservedParameters)
          Saves the reserved parameters into the form.
 void setSaveOutput(boolean saveOutput)
          Sets the saveOutput.
 void setScheduleType(java.lang.String scheduleType)
          Sets the scheduleType.
 void setSelectedTab(java.lang.String selectedTab)
          Sets the selectedTab.
 void setStartDate(java.lang.String startDate)
          Sets the startDate.
 void setStartDateUTF(java.lang.String startDate, boolean UTF8)
          Sets the startDate.
 void setStringKeep(java.lang.String stringKeep)
          Sets the stringKeep.
 void setStringSaveOutput(java.lang.String stringSaveOutput)
          Sets the stringSaveOutput.
 void setStringUseEndDateTime(java.lang.String stringUseEndDateTime)
          Sets the stringUseEndDateTime.
 void setStringUseStartDateTime(java.lang.String stringUseStartDateTime)
          Sets the stringUseStartDateTime.
 void setTotalTabs(int totalTabs)
           
 void setUseEndDateTime(boolean useEndDateTime)
          Sets the useEndDateTime.
 void setUseStartDateTime(boolean useStartDateTime)
          Sets the useStartDateTime.
 void setVersionName(java.lang.String versionName)
           
 void setVersionName(java.lang.String versionName, boolean UTF8)
          Sets the versionName.
 void setWindowName(java.lang.String windowName)
           
 
Methods inherited from class com.actuate.activeportal.forms.JobActionForm
dbg, getDocumentLocation, getDocumentName, getDocumentOutputLocation, getDocumentVersioning, getDocumentVersionName, getExecutableID, getJobId, getKeepROIIfFailed, getKeepROIIfSucceeded, getLoadTab, getNotificationAttachment, getNotifyString, getOutputFormat, getOutputFormatSupported, getSaveTab, getStructureNames, getViewInNewWindow, isAllowChangingPriority, isDocumentSave, isNotificationListSupported, isNotificationSupported, isNotify, setAllowChangingPriority, setDocumentLocation, setDocumentName, setDocumentOutputLocation, setDocumentSave, setDocumentVersioning, setDocumentVersionName, setExecutableID, setJobId, setKeepROIIfFailed, setKeepROIIfSucceeded, setLoadTab, setNotificationAttachment, setNotificationListSupported, setNotificationSupported, setNotify, setNotifyString, setOutputFormat, setOutputFormatSupported, setSaveTab, setStructureNames, setViewInNewWindow
 
Methods inherited from class com.actuate.activeportal.forms.BaseActionForm
isPostback, setPostback
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PRIORITY_LOW

public static final int PRIORITY_LOW
See Also:
Constant Field Values

PRIORITY_MED

public static final int PRIORITY_MED
See Also:
Constant Field Values

PRIORITY_HI

public static final int PRIORITY_HI
See Also:
Constant Field Values

PRIORITY_OTHER

public static final int PRIORITY_OTHER
See Also:
Constant Field Values

STR_PRIORITY_LOW

public static final java.lang.String STR_PRIORITY_LOW
See Also:
Constant Field Values

STR_PRIORITY_MED

public static final java.lang.String STR_PRIORITY_MED
See Also:
Constant Field Values

STR_PRIORITY_HI

public static final java.lang.String STR_PRIORITY_HI
See Also:
Constant Field Values

STR_PRIORITY_OTHER

public static final java.lang.String STR_PRIORITY_OTHER
See Also:
Constant Field Values
Constructor Detail

SubmitJobActionForm

public SubmitJobActionForm()
Method Detail

fixUTF8

public void fixUTF8()
Converts the form properties which is in UTF-8 encoding to internal Java String.

Overrides:
fixUTF8 in class JobActionForm

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)
Overrides:
reset in class JobActionForm

clear

public void clear()

getAbsFolder

public java.lang.String getAbsFolder()
Returns the absFolder.

Returns:
the absolute folder.

getPrecedingParameterValuesForChangedChildren

public com.actuate.schemas.ParameterValue[] getPrecedingParameterValuesForChangedChildren(com.actuate.schemas.ParameterDefinition[] paramDef,
                                                                                          com.actuate.schemas.ParameterValue[] paramValues,
                                                                                          java.lang.String changedName)
Returns the preceding parameter values for the changed parameter's child parameters.

Returns:
the preceding parameter values for the changed children.

getChildParameterDefinitions

public com.actuate.schemas.ParameterDefinition[] getChildParameterDefinitions(com.actuate.schemas.ParameterDefinition[] paramDef,
                                                                              java.lang.String changedName)

getChangedParamterName

public java.lang.String getChangedParamterName()
Returns the changed parameter name.

Returns:
the changed parameter name.

getEndDate

public java.lang.String getEndDate()
Returns the endDate.

Overrides:
getEndDate in class JobActionForm
Returns:
the end date.

getFolderType

public java.lang.String getFolderType()
Returns the folderType.

Returns:
the folder type

getHeadline

public java.lang.String getHeadline()
Returns the headline.

Returns:
the headline.

getIfExists

public java.lang.String getIfExists()
Returns the ifExists.

Returns:
the ifExists.

getInputfile

public java.lang.String getInputfile()
Returns the inputfile.

Returns:
the input file.

getJobName

public java.lang.String getJobName()
Returns the jobName.

Overrides:
getJobName in class JobActionForm
Returns:
the job name.

getJobType

public java.lang.String getJobType()
Returns the jobType.

Returns:
the job type.

isAlreadyRetrievedParameters

public boolean isAlreadyRetrievedParameters()

isKeep

public boolean isKeep()
Returns the keep.

Returns:
boolean

getNumVersions

public java.lang.String getNumVersions()
Returns the numVersions.

Returns:
String

getOnceDate

public java.lang.String getOnceDate()
Returns the onceDate.

Overrides:
getOnceDate in class JobActionForm
Returns:
the once date.

getOnceTime

public java.lang.String getOnceTime()
Returns the onceTime.

Overrides:
getOnceTime in class JobActionForm
Returns:
the once time.

getOutputName

public java.lang.String getOutputName()
Returns the outputName.

Returns:
the output name.

getOutputDocumentPath

public java.lang.String getOutputDocumentPath()
Returns the output document path.

Returns:
the output document path.

getRecurringDay

public java.lang.String getRecurringDay()
Returns the recurringDay.

Overrides:
getRecurringDay in class JobActionForm
Returns:
the recurring day.

getRecurringTime

public java.lang.String getRecurringTime()
Returns the recurringTime.

Overrides:
getRecurringTime in class JobActionForm
Returns:
the recurring time.

isSaveOutput

public boolean isSaveOutput()
Returns the saveOutput.

Returns:
boolean

getScheduleType

public java.lang.String getScheduleType()
Returns the scheduleType.

Overrides:
getScheduleType in class JobActionForm
Returns:
the schedule type.

getSelectedTab

public java.lang.String getSelectedTab()
Returns the selectedTab.

Returns:
the selected tab.

getStartDate

public java.lang.String getStartDate()
Returns the startDate.

Overrides:
getStartDate in class JobActionForm
Returns:
the start date.

isUseEndDateTime

public boolean isUseEndDateTime()
Returns the useEndDateTime.

Overrides:
isUseEndDateTime in class JobActionForm
Returns:
boolean

isUseStartDateTime

public boolean isUseStartDateTime()
Returns the useStartDateTime.

Overrides:
isUseStartDateTime in class JobActionForm
Returns:
boolean

getVersionName

public java.lang.String getVersionName()
Returns the versionName.

Returns:
the version name.

setAbsFolder

public void setAbsFolder(java.lang.String absFolder,
                         boolean UTF8)
Sets the absFolder.

Parameters:
absFolder - The absFolder to set

setAbsFolder

public void setAbsFolder(java.lang.String absFolder)

setchangedParamterName

public void setchangedParamterName(java.lang.String paramterName)

setEndDateUTF

public void setEndDateUTF(java.lang.String endDate,
                          boolean UTF8)
Sets the endDate.

Parameters:
endDate - The endDate to set

setEndDate

public void setEndDate(java.lang.String endDate)
Description copied from class: JobActionForm
Sets the endDate.

Overrides:
setEndDate in class JobActionForm
Parameters:
endDate - The endDate to set

setFolderType

public void setFolderType(java.lang.String folderType)
Sets the folderType.

Parameters:
folderType - The folderType to set

setHeadline

public void setHeadline(java.lang.String headline,
                        boolean UTF8)
Sets the headline.

Parameters:
headline - The headline to set

setHeadline

public void setHeadline(java.lang.String headline)

setIfExists

public void setIfExists(java.lang.String ifExists)
Sets the ifExists.

Parameters:
ifExists - The ifExists to set

setIsAlreadyRetrievedParameter

public void setIsAlreadyRetrievedParameter(boolean retrievedParameters)

setInputfile

public void setInputfile(java.lang.String inputfile,
                         boolean UTF8)
Sets the inputfile.

Parameters:
inputfile - The inputfile to set

setInputfile

public void setInputfile(java.lang.String inputfile)

setJobName

public void setJobName(java.lang.String jobName,
                       boolean UTF8)
Sets the jobName.

Parameters:
jobName - The jobName to set

setJobName

public void setJobName(java.lang.String jobName)
Description copied from class: JobActionForm
Sets the jobName.

Overrides:
setJobName in class JobActionForm
Parameters:
jobName - The jobName to set

setJobType

public void setJobType(java.lang.String jobType)
Sets the jobType.

Parameters:
jobType - The jobType to set

setKeep

public void setKeep(boolean keep)
Sets the keep.

Parameters:
keep - The keep to set

setNumVersions

public void setNumVersions(java.lang.String numVersions)
Sets the numVersions.

Parameters:
numVersions - The numVersions to set

setOnceDate

public void setOnceDate(java.lang.String onceDate,
                        boolean UTF8)
Sets the onceDate.

Parameters:
onceDate - The onceDate to set

setOnceDate

public void setOnceDate(java.lang.String onceDate)
Description copied from class: JobActionForm
Sets the onceDate.

Overrides:
setOnceDate in class JobActionForm
Parameters:
onceDate - The onceDate to set

setOnceTime

public void setOnceTime(java.lang.String onceTime,
                        boolean UTF8)
Sets the onceTime.

Parameters:
onceTime - The onceTime to set

setOnceTime

public void setOnceTime(java.lang.String onceTime)
Description copied from class: JobActionForm
Sets the onceTime.

Overrides:
setOnceTime in class JobActionForm
Parameters:
onceTime - The onceTime to set

setOutputName

public void setOutputName(java.lang.String outputName,
                          boolean UTF8)
Sets the outputName.

Parameters:
outputName - The outputName to set

setOutputName

public void setOutputName(java.lang.String outputName)

setOutputDocumentPath

public void setOutputDocumentPath(java.lang.String path,
                                  boolean UTF8)
sets the output document path.

Parameters:
path - the expected path to persistent the document.
UTF8 - true or false for UTF8 encoding.

setRecurringDay

public void setRecurringDay(java.lang.String recurringDay)
Sets the recurringDay, the values available is in the array recurringDayList.

Overrides:
setRecurringDay in class JobActionForm
Parameters:
recurringDay - The recurringDay to set
See Also:
JobActionForm.recurringDayList

setRecurringTime

public void setRecurringTime(java.lang.String recurringTime,
                             boolean UTF8)
Sets the recurringTime.

Parameters:
recurringTime - The recurringTime to set

setRecurringTime

public void setRecurringTime(java.lang.String recurringTime)
Description copied from class: JobActionForm
Sets the recurringTime.

Overrides:
setRecurringTime in class JobActionForm
Parameters:
recurringTime - The recurringTime to set

setSaveOutput

public void setSaveOutput(boolean saveOutput)
Sets the saveOutput.

Parameters:
saveOutput - The saveOutput to set

setScheduleType

public void setScheduleType(java.lang.String scheduleType)
Sets the scheduleType.

Overrides:
setScheduleType in class JobActionForm
Parameters:
scheduleType - The scheduleType to set

setSelectedTab

public void setSelectedTab(java.lang.String selectedTab)
Sets the selectedTab.

Parameters:
selectedTab - The selectedTab to set

setStartDateUTF

public void setStartDateUTF(java.lang.String startDate,
                            boolean UTF8)
Sets the startDate.

Parameters:
startDate - The startDate to set

setStartDate

public void setStartDate(java.lang.String startDate)
Description copied from class: JobActionForm
Sets the startDate.

Overrides:
setStartDate in class JobActionForm
Parameters:
startDate - The startDate to set

setUseEndDateTime

public void setUseEndDateTime(boolean useEndDateTime)
Sets the useEndDateTime.

Overrides:
setUseEndDateTime in class JobActionForm
Parameters:
useEndDateTime - The useEndDateTime to set

setUseStartDateTime

public void setUseStartDateTime(boolean useStartDateTime)
Sets the useStartDateTime.

Overrides:
setUseStartDateTime in class JobActionForm
Parameters:
useStartDateTime - The useStartDateTime to set

setVersionName

public void setVersionName(java.lang.String versionName,
                           boolean UTF8)
Sets the versionName.

Parameters:
versionName - The versionName to set

setVersionName

public void setVersionName(java.lang.String versionName)

getStringUseStartDateTime

public java.lang.String getStringUseStartDateTime()
Returns the stringUseStartDateTime.

Returns:
the string use start date time.

setStringUseStartDateTime

public void setStringUseStartDateTime(java.lang.String stringUseStartDateTime)
Sets the stringUseStartDateTime.

Parameters:
stringUseStartDateTime - The stringUseStartDateTime to set

getStringKeep

public java.lang.String getStringKeep()
Returns the stringKeep.

Returns:
String

getStringSaveOutput

public java.lang.String getStringSaveOutput()
Returns the stringSaveOutput.

Returns:
String

getStringUseEndDateTime

public java.lang.String getStringUseEndDateTime()
Returns the stringUseEndDateTime.

Returns:
String

setStringKeep

public void setStringKeep(java.lang.String stringKeep)
Sets the stringKeep.

Parameters:
stringKeep - The stringKeep to set

setStringSaveOutput

public void setStringSaveOutput(java.lang.String stringSaveOutput)
Sets the stringSaveOutput.

Parameters:
stringSaveOutput - The stringSaveOutput to set

setStringUseEndDateTime

public void setStringUseEndDateTime(java.lang.String stringUseEndDateTime)
Sets the stringUseEndDateTime.

Parameters:
stringUseEndDateTime - The stringUseEndDateTime to set

getInvokeSubmit

public java.lang.String getInvokeSubmit()
Returns the invokeSubmit.

Returns:
String

setInvokeSubmit

public void setInvokeSubmit(java.lang.String invokeSubmit)
Sets the invokeSubmit.

Parameters:
invokeSubmit - The invokeSubmit to set

setReservedParameters

public void setReservedParameters(java.util.Map reservedParameters)
Saves the reserved parameters into the form.

Parameters:
reservedParameters -

getReservedParameters

public java.util.Map getReservedParameters()

getParameterDefinitions

public com.actuate.schemas.ParameterDefinition[] getParameterDefinitions()
Returns the parameterDefinitions.

Returns:
ParameterDefinition[]

setParameterDefinitions

public void setParameterDefinitions(com.actuate.schemas.ParameterDefinition[] parameterDefinitions)
Sets the parameterDefinitions.

Parameters:
parameterDefinitions - The parameterDefinitions to set

getChangedConversionOptions

public java.lang.String getChangedConversionOptions()
Get the option that was changed recently due to a cascading ParameterDefinition conversion option

Returns:
the changed conversion options.

setChangedConversionOptions

public void setChangedConversionOptions(java.lang.String option)
Set the option that was changed due to a cascading ParameterDefinition conversion option

Parameters:
option -

getConvParameterDefinitions

public com.actuate.schemas.ParameterDefinition[] getConvParameterDefinitions()
Returns the parameterDefinitions.

Returns:
ParameterDefinition[]

setConvParameterDefinitions

public void setConvParameterDefinitions(com.actuate.schemas.ParameterDefinition[] parameterDefinitions)
Sets the parameterDefinitions.

Parameters:
parameterDefinitions - The parameterDefinitions to set

isConversionOptionSupported

public boolean isConversionOptionSupported()
Determines whether conversion option is supported by querying if the Conversion ParameterDefinition is null/empty. If it is not set, This function will return false. This is used in the struts JSP page to hide/show the conversion option attributes in the output/save as tab. ConversionOption is only supported in scheduled report generation.

Returns:
boolean

getParameterDefinitions

public com.actuate.schemas.ParameterDefinition getParameterDefinitions(int index)
Returns the parameterDefinitions.

Returns:
ParameterDefinition[]

setParameterDefinitions

public void setParameterDefinitions(int index,
                                    com.actuate.schemas.ParameterDefinition parameterDefinition)
Sets the parameterDefinition from index location.

Parameters:
index -
parameterDefinition -

getParameters

public com.actuate.schemas.ParameterValue[] getParameters()
Returns the parameters.

Overrides:
getParameters in class JobActionForm
Returns:
ParameterValue[]

setParameters

public void setParameters(com.actuate.schemas.ParameterValue[] parameters)
Sets the parameters.

Overrides:
setParameters in class JobActionForm
Parameters:
parameters - The parameters to set

getAdhocControlListParameters

public com.actuate.activeportal.utils.AdHocParameters getAdhocControlListParameters(int index)

getConvParameters

public com.actuate.schemas.ParameterValue[] getConvParameters()
Returns the parameters.

Returns:
ParameterValue

getConvParameters

public com.actuate.schemas.ParameterValue getConvParameters(int index)
Returns the parameters.

Returns:
ParameterValue

setConvParameters

public void setConvParameters(com.actuate.schemas.ParameterValue[] parameters)
Sets the parameters.

Parameters:
parameters - The parameters to set

setConvParameters

public void setConvParameters(int index,
                              com.actuate.schemas.ParameterValue parameter)
Sets the conversion parameter based on the specified index.

Parameters:
index -
parameter - The parameter to set

getConvAdhocControlListParameters

public com.actuate.activeportal.utils.AdHocParameters getConvAdhocControlListParameters(int index)

setConversionFormat

public void setConversionFormat(java.lang.String conversionFormat)
Parameters:
conversionFormat -

getConversionFormat

public java.lang.String getConversionFormat()

getParameters

public com.actuate.schemas.ParameterValue getParameters(int index)
Returns the parameterDefinitions.

Overrides:
getParameters in class JobActionForm
Returns:
ParameterDefinition[]

setParameters

public void setParameters(int index,
                          com.actuate.schemas.ParameterValue parameter)
Sets the parameter value based on the specified index.

Overrides:
setParameters in class JobActionForm
Parameters:
index -
parameter - The ParameterValue to set

isProgressive

public boolean isProgressive()
Returns the progressive.

Returns:
boolean

setProgressive

public void setProgressive(boolean progressive)
Sets the progressive.

Parameters:
progressive - The progressive to set

isArchiveBeforeDelete

public boolean isArchiveBeforeDelete()
Returns the archiveBeforeDelete.

Returns:
boolean

getArchivePolicy

public java.lang.String getArchivePolicy()
Returns the archivePolicy.

Returns:
String

getExpireAge

public java.lang.String getExpireAge()
Returns the expireAge.

Returns:
String

getExpireDate

public java.lang.String getExpireDate()
Returns the expireDate.

Returns:
String

getExpireTime

public java.lang.String getExpireTime()
Returns the expireTime.

Returns:
String

setArchiveBeforeDelete

public void setArchiveBeforeDelete(boolean archiveBeforeDelete)
Sets the archiveBeforeDelete.

Parameters:
archiveBeforeDelete - The archiveBeforeDelete to set

setArchivePolicy

public void setArchivePolicy(java.lang.String archivePolicy)
Sets the archivePolicy.

Parameters:
archivePolicy - The archivePolicy to set

setExpireAge

public void setExpireAge(java.lang.String expireAge)
Sets the expireAge.

Parameters:
expireAge - The expireAge to set

setExpireDate

public void setExpireDate(java.lang.String expireDate,
                          boolean UTF8)
Sets the expireDate.

Parameters:
expireDate - The expireDate to set

setExpireDate

public void setExpireDate(java.lang.String expireDate)

setExpireTime

public void setExpireTime(java.lang.String expireTime,
                          boolean UTF8)
Sets the expireTime.

Parameters:
expireTime - The expireTime to set

setExpireTime

public void setExpireTime(java.lang.String expireTime)

getPriority

public int getPriority()
Returns the priority, based on the content of the radio button and text box

Returns:
String

setPriority

public void setPriority(int value)
Sets the value of the priority, updating both the radio button and the text box

Parameters:
value - The priority to set

getPriorityRadioValue

public int getPriorityRadioValue()
Returns the value of the priority radio button.

Returns:
int

setPriorityRadioValue

public void setPriorityRadioValue(int value)
Sets the value of the priority radio button

Parameters:
value - The priority to set

getOtherPriorityValue

public java.lang.Integer getOtherPriorityValue()
Returns the value of the priority text box.

Returns:
Integer

setOtherPriorityValue

public void setOtherPriorityValue(java.lang.Integer value)
/** Sets the value of the priority text box

Parameters:
value - The priority to set

getNotifyUsersByName

public java.lang.String[] getNotifyUsersByName()
Returns the notifyUsersByName.

Returns:
String[]

setNotifyUsersByName

public void setNotifyUsersByName(java.lang.String[] notifyUsersByName)
Sets the notifyUsersByName.

Parameters:
notifyUsersByName - The notifyUsersByName to set

getNotifyChannelsByName

public java.lang.String[] getNotifyChannelsByName()
Returns the notifyChannelsByName.

Returns:
String[]

getNotifyGroupsByName

public java.lang.String[] getNotifyGroupsByName()
Returns the notifyGroupsByName.

Returns:
String[]

setNotifyChannelsByName

public void setNotifyChannelsByName(java.lang.String[] notifyChannelsByName)
Sets the notifyChannelsByName.

Parameters:
notifyChannelsByName - The notifyChannelsByName to set

setNotifyGroupsByName

public void setNotifyGroupsByName(java.lang.String[] notifyGroupsByName)
Sets the notifyGroupsByName.

Parameters:
notifyGroupsByName - The notifyGroupsByName to set

setNotificationTypes

public void setNotificationTypes(java.lang.String[] notificationTypes)

getNotificationTypes

public java.lang.String[] getNotificationTypes()

getOutputFormatTypes

public java.lang.String[] getOutputFormatTypes()

getOutputTypes

public java.lang.String[] getOutputTypes()
Returns:
the output types.

getOutputType

public java.lang.String getOutputType()
Returns:
the output type.

setOutputType

public void setOutputType(java.lang.String string)
Parameters:
string -

isOutputConversionAllowed

public boolean isOutputConversionAllowed()
Returns:
boolean

setOutputConversionAllowed

public void setOutputConversionAllowed(boolean value)
Parameters:
value -

setOutputTypes

public void setOutputTypes(java.lang.String[] strings)
Parameters:
strings -

setIPortalID

public void setIPortalID(java.lang.String parameter)

getIPortalID

public java.lang.String getIPortalID()

getTotalTabs

public int getTotalTabs()

setTotalTabs

public void setTotalTabs(int totalTabs)

setDependentFileType

public void setDependentFileType(java.lang.String fileType)
Parameters:
fileType -

getDependentFileType

public java.lang.String getDependentFileType()

setDependentFileName

public void setDependentFileName(java.lang.String fileName)
Parameters:
fileName - full path name

getDependentFileName

public java.lang.String getDependentFileName()

getWindowName

public java.lang.String getWindowName()
Returns:
the get windowName

setWindowName

public void setWindowName(java.lang.String windowName)

getRequesterPageShown

public boolean getRequesterPageShown()
Returns:
boolean

setRequesterPageShown

public void setRequesterPageShown(boolean requesterPageShown)

isUsingJSAPIParameterPage

public boolean isUsingJSAPIParameterPage()

setIsUsingJSAPIParameterPage

public void setIsUsingJSAPIParameterPage(boolean usingJSAPIParameterPage)