com.actuate.activeportal.forms
Class JobActionForm

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

public class JobActionForm
extends BaseActionForm

The base form for Job execution and Actuate Query.

See Also:
Serialized Form

Field Summary
static java.lang.String[] recurringDayList
          A string array of values valid for recurring day
 java.util.ArrayList structureNames
           
 
Constructor Summary
JobActionForm()
           
 
Method Summary
 void dbg(java.lang.String s)
           
 void fixUTF8()
           
 java.lang.String getDocumentLocation()
          Returns the documentLocation.
 java.lang.String getDocumentName()
          Returns the documentName.
 java.lang.String getDocumentOutputLocation()
          Returns the documentOutputLocation
 java.lang.String getDocumentVersioning()
          Returns the documentVersioning.
 java.lang.String getDocumentVersionName()
          Returns the documentVersionName.
 java.lang.String getEndDate()
          Returns the endDate.
 java.lang.String getExecutableID()
          Returns the executableID.
 java.lang.String getJobId()
          Returns the jobId.
 java.lang.String getJobName()
          Returns the jobName.
 boolean getKeepROIIfFailed()
           
 boolean getKeepROIIfSucceeded()
           
 java.lang.String getLoadTab()
          Returns the loadTab.
 java.lang.String getNotificationAttachment()
           
 java.lang.String getNotifyString()
           
 java.lang.String getOnceDate()
          Returns the onceDate.
 java.lang.String getOnceTime()
          Returns the onceTime.
 java.lang.String getOutputFormat()
           
 boolean getOutputFormatSupported()
           
 com.actuate.schemas.ParameterValue[] getParameters()
           
 com.actuate.schemas.ParameterValue getParameters(int index)
           
 java.lang.String getRecurringDay()
          Returns the recurringDay.
 java.lang.String getRecurringTime()
          Returns the recurringTime.
 java.lang.String getSaveTab()
          Returns the saveTab.
 java.lang.String getScheduleType()
          Returns the scheduleType.
 java.lang.String getStartDate()
          Returns the startDate.
 java.util.ArrayList getStructureNames()
           
 boolean getViewInNewWindow()
          Returns a boolean indicating whether the output should be shown in the same window or a new window
 boolean isAllowChangingPriority()
           
 boolean isDocumentSave()
          Returns the documentSave.
 boolean isNotificationListSupported()
           
 boolean isNotificationSupported()
           
 boolean isNotify()
           
 boolean isUseEndDateTime()
          Returns the useEndDateTime.
 boolean isUseStartDateTime()
          Returns the useStartDateTime.
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
           
 void setAllowChangingPriority(boolean b)
           
 void setDocumentLocation(java.lang.String documentLocation)
          Sets the documentLocation.
 void setDocumentName(java.lang.String documentName)
          Sets the documentName.
 void setDocumentOutputLocation(java.lang.String documentOutputLocation)
          Sets the documentOutputLocation.
 void setDocumentSave(boolean documentSave)
          Sets the documentSave.
 void setDocumentVersioning(java.lang.String documentVersioning)
          Sets the documentVersioning.
 void setDocumentVersionName(java.lang.String documentVersionName)
          Sets the documentVersionName.
 void setEndDate(java.lang.String endDate)
          Sets the endDate.
 void setExecutableID(java.lang.String executableID)
          Sets the executableID.
 void setJobId(java.lang.String jobId)
          Sets the jobId.
 void setJobName(java.lang.String jobName)
          Sets the jobName.
 void setKeepROIIfFailed(boolean b)
           
 void setKeepROIIfSucceeded(boolean b)
           
 void setLoadTab(java.lang.String loadTab)
          Sets the loadTab.
 void setNotificationAttachment(java.lang.String string)
           
 void setNotificationListSupported(boolean b)
           
 void setNotificationSupported(boolean b)
           
 void setNotify(boolean b)
           
 void setNotifyString(java.lang.String _notify)
           
 void setOnceDate(java.lang.String onceDate)
          Sets the onceDate.
 void setOnceTime(java.lang.String onceTime)
          Sets the onceTime.
 void setOutputFormat(java.lang.String value)
           
 void setOutputFormatSupported(boolean b)
           
 void setParameters(int index, com.actuate.schemas.ParameterValue parameterValue)
           
 void setParameters(com.actuate.schemas.ParameterValue[] parameterValues)
           
 void setRecurringDay(java.lang.String recurringDay)
          Sets the recurringDay.
 void setRecurringTime(java.lang.String recurringTime)
          Sets the recurringTime.
 void setSaveTab(java.lang.String saveTab)
          Sets the saveTab.
 void setScheduleType(java.lang.String scheduleType)
          Sets the scheduleType.
 void setStartDate(java.lang.String startDate)
          Sets the startDate.
 void setStructureNames(java.util.ArrayList list)
           
 void setUseEndDateTime(boolean useEndDateTime)
          Sets the useEndDateTime.
 void setUseStartDateTime(boolean useStartDateTime)
          Sets the useStartDateTime.
 void setViewInNewWindow(boolean bNewWindow)
           
 
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

structureNames

public java.util.ArrayList structureNames

recurringDayList

public static final java.lang.String[] recurringDayList
A string array of values valid for recurring day

Constructor Detail

JobActionForm

public JobActionForm()
Method Detail

fixUTF8

public void fixUTF8()
Overrides:
fixUTF8 in class BaseActionForm

reset

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

dbg

public void dbg(java.lang.String s)

getLoadTab

public java.lang.String getLoadTab()
Returns the loadTab.

Returns:
String

getSaveTab

public java.lang.String getSaveTab()
Returns the saveTab.

Returns:
String

setLoadTab

public void setLoadTab(java.lang.String loadTab)
Sets the loadTab.

Parameters:
loadTab - The loadTab to set

setSaveTab

public void setSaveTab(java.lang.String saveTab)
Sets the saveTab.

Parameters:
saveTab - The saveTab to set

getParameters

public com.actuate.schemas.ParameterValue[] getParameters()

getParameters

public com.actuate.schemas.ParameterValue getParameters(int index)

setParameters

public void setParameters(com.actuate.schemas.ParameterValue[] parameterValues)

setParameters

public void setParameters(int index,
                          com.actuate.schemas.ParameterValue parameterValue)

getEndDate

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

Returns:
String

getJobName

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

Returns:
String

getOnceDate

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

Returns:
String

getOnceTime

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

Returns:
String

getRecurringDay

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

Returns:
String

getRecurringTime

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

Returns:
String

getScheduleType

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

Returns:
String

getStartDate

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

Returns:
String

isUseEndDateTime

public boolean isUseEndDateTime()
Returns the useEndDateTime.

Returns:
boolean

isUseStartDateTime

public boolean isUseStartDateTime()
Returns the useStartDateTime.

Returns:
boolean

setEndDate

public void setEndDate(java.lang.String endDate)
Sets the endDate.

Parameters:
endDate - The endDate to set

setExecutableID

public void setExecutableID(java.lang.String executableID)
Sets the executableID.

Parameters:
executableID - The executableID to set

getExecutableID

public java.lang.String getExecutableID()
Returns the executableID.

Returns:
String

setJobName

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

Parameters:
jobName - The jobName to set

setOnceDate

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

Parameters:
onceDate - The onceDate to set

setOnceTime

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

Parameters:
onceTime - The onceTime to set

setRecurringDay

public void setRecurringDay(java.lang.String recurringDay)
Sets the recurringDay.

Parameters:
recurringDay - The recurringDay to set

setRecurringTime

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

Parameters:
recurringTime - The recurringTime to set

setScheduleType

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

Parameters:
scheduleType - The scheduleType to set

setStartDate

public void setStartDate(java.lang.String startDate)
Sets the startDate.

Parameters:
startDate - The startDate to set

setUseEndDateTime

public void setUseEndDateTime(boolean useEndDateTime)
Sets the useEndDateTime.

Parameters:
useEndDateTime - The useEndDateTime to set

setUseStartDateTime

public void setUseStartDateTime(boolean useStartDateTime)
Sets the useStartDateTime.

Parameters:
useStartDateTime - The useStartDateTime to set

getJobId

public java.lang.String getJobId()
Returns the jobId.

Returns:
String

setJobId

public void setJobId(java.lang.String jobId)
Sets the jobId.

Parameters:
jobId - The jobId to set

setViewInNewWindow

public void setViewInNewWindow(boolean bNewWindow)
Parameters:
bNewWindow - Set this to false if you wish the to view the output in the same window.

getViewInNewWindow

public boolean getViewInNewWindow()
Returns a boolean indicating whether the output should be shown in the same window or a new window

Returns:
boolean

getDocumentLocation

public java.lang.String getDocumentLocation()
Returns the documentLocation.

Returns:
String

getDocumentName

public java.lang.String getDocumentName()
Returns the documentName.

Returns:
String

isDocumentSave

public boolean isDocumentSave()
Returns the documentSave.

Returns:
boolean

getDocumentVersioning

public java.lang.String getDocumentVersioning()
Returns the documentVersioning.

Returns:
String

getDocumentVersionName

public java.lang.String getDocumentVersionName()
Returns the documentVersionName.

Returns:
String

setDocumentLocation

public void setDocumentLocation(java.lang.String documentLocation)
Sets the documentLocation.

Parameters:
documentLocation - The documentLocation to set

setDocumentName

public void setDocumentName(java.lang.String documentName)
Sets the documentName.

Parameters:
documentName - The documentName to set

setDocumentSave

public void setDocumentSave(boolean documentSave)
Sets the documentSave.

Parameters:
documentSave - The documentSave to set

setDocumentVersioning

public void setDocumentVersioning(java.lang.String documentVersioning)
Sets the documentVersioning.

Parameters:
documentVersioning - The documentVersioning to set

setDocumentVersionName

public void setDocumentVersionName(java.lang.String documentVersionName)
Sets the documentVersionName.

Parameters:
documentVersionName - The documentVersionName to set

getDocumentOutputLocation

public java.lang.String getDocumentOutputLocation()
Returns the documentOutputLocation

Returns:
String "personal" or "other"

setDocumentOutputLocation

public void setDocumentOutputLocation(java.lang.String documentOutputLocation)
Sets the documentOutputLocation.

Parameters:
documentOutputLocation - The documentOutputLocation to set

getStructureNames

public final java.util.ArrayList getStructureNames()
Returns:
the structure names.

setStructureNames

public final void setStructureNames(java.util.ArrayList list)
Parameters:
list -

getNotificationAttachment

public java.lang.String getNotificationAttachment()
Returns:
the notification attachment.

isNotify

public boolean isNotify()
Returns:
boolean

setNotificationAttachment

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

setNotify

public void setNotify(boolean b)
Parameters:
b -

getNotifyString

public java.lang.String getNotifyString()

setNotifyString

public void setNotifyString(java.lang.String _notify)

isNotificationSupported

public boolean isNotificationSupported()
Returns:
boolean

setNotificationSupported

public void setNotificationSupported(boolean b)
Parameters:
b -

isNotificationListSupported

public boolean isNotificationListSupported()
Returns:
boolean

setNotificationListSupported

public void setNotificationListSupported(boolean b)
Parameters:
b -

setOutputFormatSupported

public void setOutputFormatSupported(boolean b)
Parameters:
b -

getOutputFormatSupported

public boolean getOutputFormatSupported()
Returns:
boolean

setOutputFormat

public void setOutputFormat(java.lang.String value)
Parameters:
value -

getOutputFormat

public java.lang.String getOutputFormat()
Returns:
the output format.

setKeepROIIfSucceeded

public void setKeepROIIfSucceeded(boolean b)
Parameters:
b -

getKeepROIIfSucceeded

public boolean getKeepROIIfSucceeded()
Returns:
boolean

setKeepROIIfFailed

public void setKeepROIIfFailed(boolean b)
Parameters:
b -

getKeepROIIfFailed

public boolean getKeepROIIfFailed()
Returns:
boolean

isAllowChangingPriority

public boolean isAllowChangingPriority()
Returns:
boolean

setAllowChangingPriority

public void setAllowChangingPriority(boolean b)
Parameters:
b -