com.actuate.activeportal.beans
Class CreateQueryBean

java.lang.Object
  extended by com.actuate.activeportal.beans.CreateQueryBean
All Implemented Interfaces:
java.io.Serializable

public class CreateQueryBean
extends java.lang.Object
implements java.io.Serializable

This bean contains Actuate Query information which can be used for creating, editing and running a query (dov) from a data source (dox).

AcCreateQueryAction and AcRunQueryAction store this bean as a session bean with attribute name "createQueryBean". The action classes uses IDAPI GetQuery to get a query definition from a dox, then set the query definition to this bean using setQueryDefinition.

Author:
Actuate Corporation
See Also:
Serialized Form

Field Summary
static java.lang.String[] operatorsBoolean
          Operators for filtering a Boolean parameter
static java.lang.String[] operatorsDefault
          Operators for filtering non String/Boolean parameter
static java.lang.String[] operatorsString
          Operators for filtering a String parameter
 
Constructor Summary
CreateQueryBean()
          The default constructor.
 
Method Summary
 void addGroup(java.lang.String[] strings)
          Adds the specified columns as group nodes.
 boolean addSelectValueList(com.actuate.schemas.ParameterDefinition parameterDefinition, java.lang.String value)
          This is a utility function to add a select value list to a parameter with control type=ControlType.ControlListAllowNew.
 java.util.Vector getAvailableColumns()
          Returns all the columns available in this query
 com.actuate.schemas.ColumnDefinition[] getColumnDefinitions()
          Returns the definitions of all the columns in the query.
 java.lang.String getColumnDefinitionsJSArray()
          Returns the script code for constructing a javascript array that stores the column definitions.
 com.actuate.schemas.ColumnDefinition[] getColumnFilters()
          Returns the list of columns that have been used as filters on this query
 java.util.Vector getColumnsAvailableToGroup()
          Returns the list of columns that are available for grouping Each object is an instance of ColumnDefinition
 java.lang.String getDataSourceID()
          Returns the id of the dox file.
 java.lang.String getDataSourceName()
          Returns the name of the dox file.
 java.lang.String[] getDisplayedTabs()
          Returns the list of displayed tabs.
 java.lang.String getDocumentLocation()
          Returns the path to the folder in the encylcopedia where the output document will be saved
 java.lang.String getDocumentName()
          Returns the name of the output document.
 java.lang.String getDocumentOutputLocation()
          Returns the documentOutputLocation ("personal" or "other")
 java.lang.String getDocumentVersionName()
          Returns the version name that has been set for the output document.
 java.lang.String getEndDate()
          Returns the schedule end date.
 java.lang.String[][] getFilterOperators()
          Returns the filter operators for this query.
 com.actuate.schemas.FilterCriteria[] getFilters()
          Returns all the filters that have been applied to this query.
 com.actuate.activeportal.control.HtmlTree getGroups()
          Returns the tree that contains the groups
 java.lang.String getHeadline()
          Returns the headline of the query.
 java.lang.String getJobId()
          Returns the id of this job if available
 java.lang.String getJobName()
          Returns the name that has been assigned to this job.
 com.actuate.schemas.NewFile getNewFile()
          Returns the NewFile object describing the output file.
 java.lang.String getNewFileName()
          Process the actual enyclopedia file name, it appends .doi when necessary and place it in the personal folder if needed.
 java.lang.String getNotificationAttachment()
          Returns the format of the attached document that will be used when notifying the user by email.
 java.lang.String[] getNotifyChannelsByName()
          Returns the list of channel names to notify.
 java.lang.String[] getNotifyGroupsByName()
          Returns the list of group names to notify.
 java.lang.String[] getNotifyUsersByName()
          Returns the list of user names to notify.
 java.lang.String getOnceDate()
          Returns the date that has been set for a once schedule.
 java.lang.String getOnceTime()
          Returns the time that has been set for a once schedule.
 java.lang.String getOutputFormat()
          Returns the output format that has been set for this query object
 java.lang.String getPageHeader()
          Returns the page header.
 com.actuate.schemas.ParameterDefinition[] getParameterDefinitions()
          This parameter stores the list of parameter definitions that are used for presenting the UI to the user.
 com.actuate.schemas.ParameterValue[] getParameters()
          Returns the parameters that are set in this query
 int getPriority()
          Returns the job priority that has been set for this job.
 com.actuate.schemas.Query getQuery()
          Returns the query object associated with this bean.
 java.lang.String getQueryDescription()
          Returns the description that has been set for this query object
 com.actuate.schemas.NewFile getQueryFile()
          Returns the file object that is userd for representing the file in the encyclopaedia.
 java.lang.String getQueryLocation()
          Returns the location where the dov file will be saved to on the server
 java.lang.String getQueryName()
          Returns the name of this query object
 java.lang.String getRecurringDay()
          Returns the day on which this schedule is recurring(Applies for a recurring schedule) Currently one of "CH_EVERY_DAY", "CH_WEEKDAYS", "CH_MONDAYS", "CH_TUESDAYS", "CH_WEDNESDAYS", "CH_THURSDAYS", "CH_FRIDAYS", "CH_SATURDAYS", "CH_SUNDAYS", "CH_FIRST_DAY_OF_MONTH", "CH_LAST_DAY_OF_MONTH"
 java.lang.String getRecurringTime()
          Returns the time at which the schedule repeats on the specified day
 java.lang.String getSaveName()
          Returns the name of the dov file that will be used when saving the query.
 java.lang.String getScheduleType()
          Returns the schedule type "immediate", "once" or "recurring"
 java.util.Vector getSelectedColumns()
          Returns the list of all the selected columns in the query.
 java.lang.String getSelectedColumnsAsString()
          Return the list of selected column names in a comma separated list, for example: "column1,column2,column3"
 com.actuate.activeportal.control.HtmlTreeNode getSelectedNode()
          Returns the currently selected node in the group tree
 java.util.Collection getSortableColumns()
          Returns the columns that are available for sorting
 java.util.Vector getSortColumns()
          Returns the list of all the columns which have been selected for sorting
 java.lang.String getStartDate()
          Returns the start date of the schedule
 java.util.LinkedList getStructureNames()
          Returns the names of all the structure type parameters in this query
 java.util.Vector getSummaryColumns()
          Returns the list of colums that are available for displaying in the summaries tab.
 java.lang.String getSupportedQueryFeatures()
          Returns a string indicating the supported Actuate Query features
 java.lang.String getTimeZoneName()
          Returns the name of the time zone used by the query
 java.lang.String getUiVersion()
           
 com.actuate.schemas.Query getUpdatedQuery(com.actuate.reportcast.utils.AcRequestHandlerBean m_requestHandler)
          Returns the updated query that is finally submitted to the server.
 java.lang.String getValueFromSupportedQueryFeaturesExtended(java.lang.String propertyName)
           
 boolean getViewInNewWindow()
          Returns whether the target window for query result viewer is the same or a new one
 int getVisibleParameterCount()
          Returns the number of visible parameters in this query.
 int getVisiblePromptParameterCount()
          Returns the number of visible parameters that are to be prompted for by the UI.
 boolean getWritable()
          Returns false if user doesn't have write permission on query.
 boolean isAllowGroupingChangeAtRuntime()
          Returns a boolean indicating whether the grouping is allowed to be changed at runtime
 boolean isAllowSummaryChangeAtRuntime()
          Returns a boolean indicating whether the summary can be changed at runtime
 boolean isAnyGroupPresent()
          Checks to see if any grouping has been created for this query.
 boolean isAnySummaryActive()
          Checks to see if any summaries are currently active.
 boolean isDocumentReplaceExisting()
          Returns a boolean indicating whether any existing file will be replaced when this query is executed.
 boolean isDocumentSave()
          Returns a booolean indicating whether the output file is to be saved or not.
 boolean isForRunning()
          Returns a boolean indicating whether this query was invoked as an immediate job
 boolean isGroupingEnabled()
          Returns a boolean indicating whether grouping is enabled for this query object or not.
 boolean isNotify()
          Returns a boolean indicating whether the user has indicated that they wish to be notified about this job
 boolean isOutputDistinctRowsOnly()
          Returns a boolean indicating whether the duplicate rows should be skipped
 boolean isProgressiveViewing()
          Returns a boolean indicating whether the query is viewed progressively
 boolean isProgressiveViewingLogic()
          Returns a boolean indicating if the current settings supports progressive viewing.
 boolean isPromptFilterPage()
          Returns a boolean indicating whether the filter page is supposed to be shown or not
 boolean isPromptOutputFormat()
          Returns a boolean indicating whether the output format is supposed to be prompted for or not.
 boolean isPromptSelectColumnList()
          Returns a boolean indicating whether the user should be able to change the selected column lst when running the query..
 boolean isPromptSortColumnList()
          Returns a boolean indicating whether the user is allowed to change the sort column list when executing the query.
 boolean isShowRowCountsInTotal()
          Returns a boolean indicating whether row counts should be shown in the query output.
 boolean isSubmitQuery()
          Returns a boolean indicating whether this is a background job or an immediate job.
 boolean isSuppressDetailRows()
          Returns a boolean indicating whether server detail rows should be supporessed in the query output
 boolean isUseEndDateTime()
          Returns a boolean indicating whether the end date and time are set
 boolean isUseStartDateTime()
          Returns a boolean indicating whether the start date and time are set
 void newFilterColumn(java.lang.String columnName, java.lang.String filterOperator, java.lang.String filterValue, boolean filterPrompt)
          This method adds a new filter expression to the filters already applied on the query.
 void newSortColumn(java.lang.String columnName, java.lang.String sortOrder)
          This method is called to add a new column to the list of columns on which the query is to be sorted on.
 void refreshGroups()
          Refreshes the group tree based on the selected columns
 void refreshSortColumns()
          Refreshes the list of sort columns based on the selected columns
 void refreshSummaryColumns()
          Refreshes the list of available summary columns
 void setAllowGroupingChangeAtRuntime(boolean b)
          Sets a boolean indicating whether the grouping is allowed to be changed at runtime.
 void setAllowSummaryChangeAtRuntime(boolean b)
          Specifies whether the summary is allowed to be changed at runtime
 void setAvailableColumns(java.util.Vector availableColumns)
          Sets the list of columns available to query.
 void setDataSourceID(java.lang.String dataSourceID)
          Sets the id of the dox file
 void setDataSourceName(java.lang.String dataSourceName)
          Sets the name of the dox file
 void setDisplayedTabs(java.lang.String[] displayedTabs)
          Sets the list of tabs that are to be displayed in the query UI.
 void setDocumentLocation(java.lang.String documentLocation)
          Sets the path of the folder to where the output document is saved in the encyclopaedia.
 void setDocumentName(java.lang.String documentName)
          Sets the name of the output document
 void setDocumentOutputLocation(java.lang.String documentOutputLocation)
          Sets the documentOutputLocation.
 void setDocumentReplaceExisting(boolean documentReplaceExisting)
          Specifies whether the output document will replace any existing documents
 void setDocumentSave(boolean documentSave)
          Specifies whether the output document should be saved or not.
 void setDocumentVersionName(java.lang.String documentVersionName)
          Sets the version name of the output document
 void setEndDate(java.lang.String endDate)
          Sets the end date of the schedule
 void setFilters(com.actuate.schemas.FilterCriteria[] filters)
          Sets the filters that are to be applied to this query
 void setFilters(com.actuate.schemas.FilterCriteria[] filters, java.lang.Boolean valuesOnly)
          copy filter operator and value only.
 void setForRunning(boolean forRunning)
          Specifies whether the query should be run as an immediate job.
 void setHeadline(java.lang.String string)
          Sets the headline of the query.
 void setJobId(java.lang.String jobId)
          Sets the id of the job that this query executed under.
 void setJobName(java.lang.String jobName)
          Sets the name for this job.
 void setNewFile(com.actuate.schemas.NewFile file)
          Sets the NewFile object describing the output file.
 void setNotificationAttachment(java.lang.String string)
          Sets the format of the attachment that is to be used when notifying.
 void setNotify(boolean b)
          Specifies ehether the user wishes to be notified or not.
 void setNotifyChannelsByName(java.lang.String[] strings)
          Sets the list of channel names to notify.
 void setNotifyGroupsByName(java.lang.String[] strings)
          Sets the list of group names to notify.
 void setNotifyUsersByName(java.lang.String[] strings)
          Sets the list of user names to notify.
 void setOnceDate(java.lang.String onceDate)
          Sets the date on which the job should be run if the schedule is set to once.
 void setOnceTime(java.lang.String onceTime)
          Sets the time on which the job should be run if the schedule is set to once.
 void setOutputDistinctRowsOnly(boolean b)
          Sets a boolean indicating whether the duplicate rows should be skipped
 void setOutputFormat(java.lang.String outputFormat)
          Sets the output format to be generated when the query is executed.
 void setPageHeader(java.lang.String pageHeader)
          Sets the page header for the output
 void setParameters(com.actuate.schemas.ParameterValue[] parameters, java.lang.Boolean valuesOnly)
          Updates the parameter for this query.
 void setPriority(int i)
          Sets the priority of this job
 void setProgressiveViewing(boolean b)
          Sets a boolean indicating whether the query should be viewed progressively
 void setPromptFilterPage(boolean promptFilterPage)
          Sets a boolean indicating whether the filter page is supposed to be shown.
 void setPromptOutputFormat(boolean promptOutputFormat)
          Sets whether the user should be allowed to change the output format when running the query.
 void setPromptSelectColumnList(boolean promptSelectColumnList)
          Sets whether the use is allowed to change the list of selected columns when running the query.
 void setPromptSortColumnList(boolean promptSortColumnList)
          Sets whether the user is allowed to change the sort column list when running the query.
 void setQuery(com.actuate.schemas.Query query)
          Sets the query object that is retrieved from the server.
 void setQueryDefinition(com.actuate.schemas.Query queryDefinition, com.actuate.activeportal.beans.TableParameterListBean tableBean)
          Set this bean's query definition.
 void setQueryDescription(java.lang.String queryDescription)
          Sets the description of this query object
 void setQueryLocation(java.lang.String queryLocation)
          Sets the location where the dov file will be saved to on the server
 void setQueryName(java.lang.String queryName)
          Sets the name of this query object
 void setRecurringDay(java.lang.String recurringDay)
          Sets the day on which the schedule reruns
 void setRecurringTime(java.lang.String recurringTime)
          Sets the time at which the schedule recurs
 void setScheduleType(java.lang.String scheduleType)
          Sets the Schedule type "immediate", "once" or "recurring"
 void setSelectedColumnAsString(java.lang.String columnList)
          Sets the selectedColumns.
 void setSelectedColumns(java.util.Vector selectedColumns)
          Sets the list of selected columns for this query.
 void setSelectedNode(com.actuate.activeportal.control.HtmlTreeNode node)
          Sets the currently selected node in the group tree.
 void setShowRowCountsInTotal(boolean b)
          Sets a boolean indicating whether row counts are supposed to be shown
 void setSortNameOrder(java.lang.String[] sortName, java.lang.String[] sortOrder)
          This method sets the sort columns of the query and their sort order.
 void setStartDate(java.lang.String startDate)
          Sets the date at which the job starts executing
 void setSubmitQuery(boolean submitQuery)
          Specifies whether this is a background job or a immediate job.
 void setSuppressDetailRows(boolean b)
          Set a boolean indicating whether detail rows will be suppressed from query result
 void setTimeZoneName(java.lang.String timeZoneName)
          Sets the time zone to be used by the query
 void setUseEndDateTime(boolean useEndDateTime)
          Indicates whether this job uses the end date and time
 void setUseStartDateTime(boolean useStartDateTime)
          Indicates whether this job uses the start date and time
 void setViewInNewWindow(boolean bViewInNewWindow)
          Sets the target window for query result viewer to a new window or current window
 void setVisibleParameterCount(int visibleParameterCount)
          Sets the number of visible parameters.
 void setWritable(boolean value)
           
 void updateGroupSortOrder(java.util.List list)
          Updates the sort order for the group nodes with the ones in the list passed Each item in the list is an instance of HtmlTreeNode with the data set to ASC/DESc
 void updateSummaryColumns(java.util.Vector vector)
          This method takes the function value from the summary columns vector passed and updates the one in the bean with this value.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

operatorsString

public static final java.lang.String[] operatorsString
Operators for filtering a String parameter


operatorsBoolean

public static final java.lang.String[] operatorsBoolean
Operators for filtering a Boolean parameter


operatorsDefault

public static final java.lang.String[] operatorsDefault
Operators for filtering non String/Boolean parameter

Constructor Detail

CreateQueryBean

public CreateQueryBean()
The default constructor. This initializes all the default variables.

Method Detail

newSortColumn

public void newSortColumn(java.lang.String columnName,
                          java.lang.String sortOrder)
This method is called to add a new column to the list of columns on which the query is to be sorted on. This is called by the action class whenever the user adds a new column to the sorting list.

Parameters:
columnName - The name of the column
sortOrder - The order ASC/DESC

setSortNameOrder

public void setSortNameOrder(java.lang.String[] sortName,
                             java.lang.String[] sortOrder)
This method sets the sort columns of the query and their sort order. The names of the columns should be passed in the sortName array and the order should be passed in the sort order array.

Parameters:
sortName - The list of column names on which the query is to be sorted
sortOrder - The sorting order of each of the columns i.e. ASC/DESC.

newFilterColumn

public void newFilterColumn(java.lang.String columnName,
                            java.lang.String filterOperator,
                            java.lang.String filterValue,
                            boolean filterPrompt)
This method adds a new filter expression to the filters already applied on the query. The filters can be one of the following

Parameters:
columnName - The column on which the filter expression is to be applied
filterOperator - The filter operator. Should be one of the operators shown above
filterValue - The value for the filter expression
filterPrompt - A boolean indicating whether the filter should be prompted for when executing the query

addSelectValueList

public boolean addSelectValueList(com.actuate.schemas.ParameterDefinition parameterDefinition,
                                  java.lang.String value)
This is a utility function to add a select value list to a parameter with control type=ControlType.ControlListAllowNew.

Parameters:
parameterDefinition - the parameter object to which the string has to be added for displaying in the list
value - The value to be added to the list
Returns:
A boolean indicating whether the value has been added or not.

setQueryDefinition

public void setQueryDefinition(com.actuate.schemas.Query queryDefinition,
                               com.actuate.activeportal.beans.TableParameterListBean tableBean)
Set this bean's query definition. The definition should be from GetQuery. It will prepare this bean to do another query. Initially the selected columns set to none. Then parameter values are initialized.

Parameters:
queryDefinition - The query definition retrieved from the server.

setSelectedColumnAsString

public void setSelectedColumnAsString(java.lang.String columnList)
Sets the selectedColumns. Used in query/content.jsp

Parameters:
columnList - The selectedColumns to set, a list of column name in comma separated list

getSelectedColumnsAsString

public java.lang.String getSelectedColumnsAsString()
Return the list of selected column names in a comma separated list, for example: "column1,column2,column3"

Returns:
the String of comma separated list

getDataSourceName

public java.lang.String getDataSourceName()
Returns the name of the dox file.

Returns:
String The query file name

getDataSourceID

public java.lang.String getDataSourceID()
Returns the id of the dox file.

Returns:
String The query file id

setDataSourceID

public void setDataSourceID(java.lang.String dataSourceID)
Sets the id of the dox file

Parameters:
dataSourceID - The dataSourceID to set

setDataSourceName

public void setDataSourceName(java.lang.String dataSourceName)
Sets the name of the dox file

Parameters:
dataSourceName - The dataSourceName to set

getAvailableColumns

public java.util.Vector getAvailableColumns()
Returns all the columns available in this query

Returns:
Vector The list of available columns

getSelectedColumns

public java.util.Vector getSelectedColumns()
Returns the list of all the selected columns in the query. Each element in this list is of the type ColumnDefinition.

Returns:
Vector The list of selected columns

setAvailableColumns

public void setAvailableColumns(java.util.Vector availableColumns)
Sets the list of columns available to query. This is called by the action class.

Parameters:
availableColumns - The list of available columns

setSelectedColumns

public void setSelectedColumns(java.util.Vector selectedColumns)
Sets the list of selected columns for this query. Each element is of the type ColumnDefinition

Parameters:
selectedColumns - The list of selected columns

getColumnDefinitions

public com.actuate.schemas.ColumnDefinition[] getColumnDefinitions()
Returns the definitions of all the columns in the query.

Returns:
ColumnDefinition[] The definition of all the columns

isPromptOutputFormat

public boolean isPromptOutputFormat()
Returns a boolean indicating whether the output format is supposed to be prompted for or not.

Returns:
boolean true if the output format is supposed to be prompted, false otherwise

isPromptSelectColumnList

public boolean isPromptSelectColumnList()
Returns a boolean indicating whether the user should be able to change the selected column lst when running the query..

Returns:
boolean true if the columns are allowed to be modified, false otherwise.

isPromptSortColumnList

public boolean isPromptSortColumnList()
Returns a boolean indicating whether the user is allowed to change the sort column list when executing the query.

Returns:
boolean true if the sort column list can be changed, false othewise.

setPromptOutputFormat

public void setPromptOutputFormat(boolean promptOutputFormat)
Sets whether the user should be allowed to change the output format when running the query.

Parameters:
promptOutputFormat - true if teh use is allowed to change the output format, false otherwise.

setPromptSelectColumnList

public void setPromptSelectColumnList(boolean promptSelectColumnList)
Sets whether the use is allowed to change the list of selected columns when running the query.

Parameters:
promptSelectColumnList - true if the user is allowed to change the list, false otherwise.

setPromptSortColumnList

public void setPromptSortColumnList(boolean promptSortColumnList)
Sets whether the user is allowed to change the sort column list when running the query.

Parameters:
promptSortColumnList - true if the user is allowed to change the sort columns, false otherwise.

getSortColumns

public java.util.Vector getSortColumns()
Returns the list of all the columns which have been selected for sorting

Returns:
Vector The list of sorting columns

setOutputFormat

public void setOutputFormat(java.lang.String outputFormat)
Sets the output format to be generated when the query is executed. This can be one of the following DHTML, XLS, PDF, EANALYSIS(If the server has this option enabled)

Parameters:
outputFormat - the output format to be used.

setQueryDescription

public void setQueryDescription(java.lang.String queryDescription)
Sets the description of this query object

Parameters:
queryDescription - The description

getOutputFormat

public java.lang.String getOutputFormat()
Returns the output format that has been set for this query object

Returns:
String The output format

getQueryDescription

public java.lang.String getQueryDescription()
Returns the description that has been set for this query object

Returns:
String The query description

getQueryLocation

public java.lang.String getQueryLocation()
Returns the location where the dov file will be saved to on the server

Returns:
String The location to save the query to

getQueryName

public java.lang.String getQueryName()
Returns the name of this query object

Returns:
String The query name

setQueryLocation

public void setQueryLocation(java.lang.String queryLocation)
Sets the location where the dov file will be saved to on the server

Parameters:
queryLocation - The location to save the query to

setQueryName

public void setQueryName(java.lang.String queryName)
Sets the name of this query object

Parameters:
queryName - The name of the query object

getFilters

public com.actuate.schemas.FilterCriteria[] getFilters()
Returns all the filters that have been applied to this query.

Returns:
FilterCriteria[] The list of filters

setFilters

public void setFilters(com.actuate.schemas.FilterCriteria[] filters)
Sets the filters that are to be applied to this query

Parameters:
filters - The filters to apply

setFilters

public void setFilters(com.actuate.schemas.FilterCriteria[] filters,
                       java.lang.Boolean valuesOnly)
copy filter operator and value only.

valuesOnly is for execute.do and submit.do
filters is from URL parameter ../execute.do? filters[0].name=OrderTotals_orderID& filters[0].operation=%3c%3d& filters[0].value=1500


getParameterDefinitions

public com.actuate.schemas.ParameterDefinition[] getParameterDefinitions()
This parameter stores the list of parameter definitions that are used for presenting the UI to the user. A structure column parameter is stored as a separate definition in this.

Returns:
ParameterDefinition[]

getParameters

public com.actuate.schemas.ParameterValue[] getParameters()
Returns the parameters that are set in this query

Returns:
ParameterValue[] The list of parameters

setParameters

public void setParameters(com.actuate.schemas.ParameterValue[] parameters,
                          java.lang.Boolean valuesOnly)
Updates the parameter for this query.

Parameters:
parameters - The parameters to be updated
valuesOnly - A boolean indicating whether only the values of the parameters should be updated

getQuery

public com.actuate.schemas.Query getQuery()
Returns the query object associated with this bean.

Returns:
Query The query object

getQueryFile

public com.actuate.schemas.NewFile getQueryFile()
Returns the file object that is userd for representing the file in the encyclopaedia. This is created when when user wishes to save the query definition in the encyclopedia.

Returns:
NewFile The query file

getPageHeader

public java.lang.String getPageHeader()
Returns the page header.

Returns:
String The page header

setPageHeader

public void setPageHeader(java.lang.String pageHeader)
Sets the page header for the output

Parameters:
pageHeader - The pageHeader

getDocumentLocation

public java.lang.String getDocumentLocation()
Returns the path to the folder in the encylcopedia where the output document will be saved

Returns:
String The output document location

getDocumentName

public java.lang.String getDocumentName()
Returns the name of the output document.

Returns:
String The document name

getDocumentOutputLocation

public java.lang.String getDocumentOutputLocation()
Returns the documentOutputLocation ("personal" or "other")

Returns:
String The output location

isDocumentReplaceExisting

public boolean isDocumentReplaceExisting()
Returns a boolean indicating whether any existing file will be replaced when this query is executed.

Returns:
boolean true if the output file will be replaced, false otherwise

isDocumentSave

public boolean isDocumentSave()
Returns a booolean indicating whether the output file is to be saved or not.

Returns:
boolean true if the output file is to be saved

getDocumentVersionName

public java.lang.String getDocumentVersionName()
Returns the version name that has been set for the output document.

Returns:
String The version name

setDocumentLocation

public void setDocumentLocation(java.lang.String documentLocation)
Sets the path of the folder to where the output document is saved in the encyclopaedia.

Parameters:
documentLocation - The output document location

setDocumentName

public void setDocumentName(java.lang.String documentName)
Sets the name of the output document

Parameters:
documentName - The name of the output document

setDocumentOutputLocation

public void setDocumentOutputLocation(java.lang.String documentOutputLocation)
Sets the documentOutputLocation. "personal" or "other"

Parameters:
documentOutputLocation - The documentOutputLocation to set

setDocumentReplaceExisting

public void setDocumentReplaceExisting(boolean documentReplaceExisting)
Specifies whether the output document will replace any existing documents

Parameters:
documentReplaceExisting - true if exiting versions should be replaced, false otherwise

setDocumentSave

public void setDocumentSave(boolean documentSave)
Specifies whether the output document should be saved or not.

Parameters:
documentSave - true if the document should be saved, false otherwise

setDocumentVersionName

public void setDocumentVersionName(java.lang.String documentVersionName)
Sets the version name of the output document

Parameters:
documentVersionName - The version name

getDisplayedTabs

public java.lang.String[] getDisplayedTabs()
Returns the list of displayed tabs. This is used by the page to decide which tabs to show.

Returns:
String[] The names of the displayed tabs

getEndDate

public java.lang.String getEndDate()
Returns the schedule end date.

Returns:
String The end date

getJobName

public java.lang.String getJobName()
Returns the name that has been assigned to this job.

Returns:
String The job name

getOnceDate

public java.lang.String getOnceDate()
Returns the date that has been set for a once schedule.

Returns:
String The date in the locale format

getOnceTime

public java.lang.String getOnceTime()
Returns the time that has been set for a once schedule.

Returns:
String The time in the locale format

getRecurringDay

public java.lang.String getRecurringDay()
Returns the day on which this schedule is recurring(Applies for a recurring schedule) Currently one of "CH_EVERY_DAY", "CH_WEEKDAYS", "CH_MONDAYS", "CH_TUESDAYS", "CH_WEDNESDAYS", "CH_THURSDAYS", "CH_FRIDAYS", "CH_SATURDAYS", "CH_SUNDAYS", "CH_FIRST_DAY_OF_MONTH", "CH_LAST_DAY_OF_MONTH"

Returns:
String The day on which the schedule repeats

getRecurringTime

public java.lang.String getRecurringTime()
Returns the time at which the schedule repeats on the specified day

Returns:
String The recurring time in the current locale format

getScheduleType

public java.lang.String getScheduleType()
Returns the schedule type "immediate", "once" or "recurring"

Returns:
String The schedule type

getStartDate

public java.lang.String getStartDate()
Returns the start date of the schedule

Returns:
String The start date

isUseEndDateTime

public boolean isUseEndDateTime()
Returns a boolean indicating whether the end date and time are set

Returns:
boolean true if the end date and time are set, false otherwise

isUseStartDateTime

public boolean isUseStartDateTime()
Returns a boolean indicating whether the start date and time are set

Returns:
boolean true if the start date and time are set, false otherwise

setEndDate

public void setEndDate(java.lang.String endDate)
Sets the end date of the schedule

Parameters:
endDate - The end date to set

setJobName

public void setJobName(java.lang.String jobName)
Sets the name for this job.

Parameters:
jobName - The job name

setOnceDate

public void setOnceDate(java.lang.String onceDate)
Sets the date on which the job should be run if the schedule is set to once.

Parameters:
onceDate - The date to run the job on

setOnceTime

public void setOnceTime(java.lang.String onceTime)
Sets the time on which the job should be run if the schedule is set to once.

Parameters:
onceTime - The time to run the job on

setRecurringDay

public void setRecurringDay(java.lang.String recurringDay)
Sets the day on which the schedule reruns

Parameters:
recurringDay - The day on which the schedule reruns

setRecurringTime

public void setRecurringTime(java.lang.String recurringTime)
Sets the time at which the schedule recurs

Parameters:
recurringTime - The recurring time

setScheduleType

public void setScheduleType(java.lang.String scheduleType)
Sets the Schedule type "immediate", "once" or "recurring"

Parameters:
scheduleType - The type of schedule

setStartDate

public void setStartDate(java.lang.String startDate)
Sets the date at which the job starts executing

Parameters:
startDate - The start date of the job

setUseEndDateTime

public void setUseEndDateTime(boolean useEndDateTime)
Indicates whether this job uses the end date and time

Parameters:
useEndDateTime - true if the end date and time are to be used, false otherwise

setUseStartDateTime

public void setUseStartDateTime(boolean useStartDateTime)
Indicates whether this job uses the start date and time

Parameters:
useStartDateTime - true if the start date and time are to be used, false otherwise

isSubmitQuery

public boolean isSubmitQuery()
Returns a boolean indicating whether this is a background job or an immediate job.

Returns:
boolean true if it is a background job, false otherwise

setSubmitQuery

public void setSubmitQuery(boolean submitQuery)
Specifies whether this is a background job or a immediate job. Used to display schedule tab or not.

Parameters:
submitQuery - true if this is a background job, false otherwise

setDisplayedTabs

public void setDisplayedTabs(java.lang.String[] displayedTabs)
Sets the list of tabs that are to be displayed in the query UI. This is called by the action class.

Parameters:
displayedTabs - The name of the tabs to be displayed

getSaveName

public java.lang.String getSaveName()
Returns the name of the dov file that will be used when saving the query.

Returns:
The file name used when saving

getColumnFilters

public com.actuate.schemas.ColumnDefinition[] getColumnFilters()
Returns the list of columns that have been used as filters on this query

Returns:
ColumnDefinition[] The columns which have been used as filters

isForRunning

public boolean isForRunning()
Returns a boolean indicating whether this query was invoked as an immediate job

Returns:
boolean true if the query is to be executed as an immediate job, false otherwise

setForRunning

public void setForRunning(boolean forRunning)
Specifies whether the query should be run as an immediate job.

Parameters:
forRunning - true if the query should be run as an immediate job.

isPromptFilterPage

public boolean isPromptFilterPage()
Returns a boolean indicating whether the filter page is supposed to be shown or not

Returns:
boolean true if the filter page is to be shown, false otherwise

setPromptFilterPage

public void setPromptFilterPage(boolean promptFilterPage)
Sets a boolean indicating whether the filter page is supposed to be shown.

Parameters:
promptFilterPage - true if the filter page is supposed to be shown.

setQuery

public void setQuery(com.actuate.schemas.Query query)
Sets the query object that is retrieved from the server.

Parameters:
query - The query object

getTimeZoneName

public java.lang.String getTimeZoneName()
Returns the name of the time zone used by the query

Returns:
String The time zone name

setTimeZoneName

public void setTimeZoneName(java.lang.String timeZoneName)
Sets the time zone to be used by the query

Parameters:
timeZoneName - Time zone name

getJobId

public java.lang.String getJobId()
Returns the id of this job if available

Returns:
String The job id

setJobId

public void setJobId(java.lang.String jobId)
Sets the id of the job that this query executed under. This is called if you are editing a scheduled query.

Parameters:
jobId - The job id

setViewInNewWindow

public void setViewInNewWindow(boolean bViewInNewWindow)
Sets the target window for query result viewer to a new window or current window

Parameters:
bViewInNewWindow - if true a new window is launched.

getViewInNewWindow

public boolean getViewInNewWindow()
Returns whether the target window for query result viewer is the same or a new one

Returns:
true if a new window is to be launched

getNewFileName

public java.lang.String getNewFileName()
Process the actual enyclopedia file name, it appends .doi when necessary and place it in the personal folder if needed. The name returned includes the full path location.

Returns:
the file name

getFilterOperators

public java.lang.String[][] getFilterOperators()
Returns the filter operators for this query.

Returns:
the String[][] of filters

getVisibleParameterCount

public int getVisibleParameterCount()
Returns the number of visible parameters in this query.

Returns:
int The number of visible parameters

setVisibleParameterCount

public void setVisibleParameterCount(int visibleParameterCount)
Sets the number of visible parameters. This is called by the action class.

Parameters:
visibleParameterCount - The number of visible parameters

getHeadline

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

Returns:
The headline

setHeadline

public void setHeadline(java.lang.String string)
Sets the headline of the query.

Parameters:
string - The headline

isProgressiveViewing

public boolean isProgressiveViewing()
Returns a boolean indicating whether the query is viewed progressively

Returns:
true if the query is viewed progressively

setProgressiveViewing

public void setProgressiveViewing(boolean b)
Sets a boolean indicating whether the query should be viewed progressively

Parameters:
b - true if the query is to be viewed progressively.

getPriority

public int getPriority()
Returns the job priority that has been set for this job.

Returns:
the priority of the job

setPriority

public void setPriority(int i)
Sets the priority of this job

Parameters:
i - The priority level

getNewFile

public com.actuate.schemas.NewFile getNewFile()
Returns the NewFile object describing the output file.

Returns:
The file object

setNewFile

public void setNewFile(com.actuate.schemas.NewFile file)
Sets the NewFile object describing the output file.

Parameters:
file - The file object describing the output

getNotifyChannelsByName

public java.lang.String[] getNotifyChannelsByName()
Returns the list of channel names to notify.

Returns:
The names of the channels

getNotifyGroupsByName

public java.lang.String[] getNotifyGroupsByName()
Returns the list of group names to notify.

Returns:
The names of the groups

getNotifyUsersByName

public java.lang.String[] getNotifyUsersByName()
Returns the list of user names to notify.

Returns:
The names of all the users to notify

setNotifyChannelsByName

public void setNotifyChannelsByName(java.lang.String[] strings)
Sets the list of channel names to notify.

Parameters:
strings - The names of the channels to notify

setNotifyGroupsByName

public void setNotifyGroupsByName(java.lang.String[] strings)
Sets the list of group names to notify.

Parameters:
strings - The names of the groups to notify

setNotifyUsersByName

public void setNotifyUsersByName(java.lang.String[] strings)
Sets the list of user names to notify.

Parameters:
strings - The names of the users to notify

isProgressiveViewingLogic

public boolean isProgressiveViewingLogic()
Returns a boolean indicating if the current settings supports progressive viewing.

Returns:
true if the current settings support progressive viewing

getVisiblePromptParameterCount

public int getVisiblePromptParameterCount()
Returns the number of visible parameters that are to be prompted for by the UI.

Returns:
int The number of visible parameters that are to be prompted for.

getColumnDefinitionsJSArray

public java.lang.String getColumnDefinitionsJSArray()
Returns the script code for constructing a javascript array that stores the column definitions. This is used in the content page.

Returns:
the String javascript variable declaraion for column definitions

getUpdatedQuery

public com.actuate.schemas.Query getUpdatedQuery(com.actuate.reportcast.utils.AcRequestHandlerBean m_requestHandler)
Returns the updated query that is finally submitted to the server.

Parameters:
m_requestHandler - The request handler bean
Returns:
The final updated query

getStructureNames

public java.util.LinkedList getStructureNames()
Returns the names of all the structure type parameters in this query

Returns:
The structure names

getNotificationAttachment

public java.lang.String getNotificationAttachment()
Returns the format of the attached document that will be used when notifying the user by email.

Returns:
The attachment format

isNotify

public boolean isNotify()
Returns a boolean indicating whether the user has indicated that they wish to be notified about this job

Returns:
true if the user wishes to be notified

setNotificationAttachment

public void setNotificationAttachment(java.lang.String string)
Sets the format of the attachment that is to be used when notifying.

Parameters:
string - The notification attachment format

setNotify

public void setNotify(boolean b)
Specifies ehether the user wishes to be notified or not.

Parameters:
b - true if the user wishes to be notified

getColumnsAvailableToGroup

public java.util.Vector getColumnsAvailableToGroup()
Returns the list of columns that are available for grouping Each object is an instance of ColumnDefinition

Returns:
The list of columns available to group

getGroups

public com.actuate.activeportal.control.HtmlTree getGroups()
Returns the tree that contains the groups

Returns:
The group tree

addGroup

public void addGroup(java.lang.String[] strings)
Adds the specified columns as group nodes. The first item in the array is added as a group node. All the others are added as the child node of that group.

Parameters:
strings - The columns to be added as groups.

getSelectedNode

public com.actuate.activeportal.control.HtmlTreeNode getSelectedNode()
Returns the currently selected node in the group tree

Returns:
the selected node

setSelectedNode

public void setSelectedNode(com.actuate.activeportal.control.HtmlTreeNode node)
Sets the currently selected node in the group tree. This is called by the action class when the user selects a node in the group tree.

Parameters:
node - The node to be set as selected

isAllowGroupingChangeAtRuntime

public boolean isAllowGroupingChangeAtRuntime()
Returns a boolean indicating whether the grouping is allowed to be changed at runtime

Returns:
true if changing the grouping is allowed

setAllowGroupingChangeAtRuntime

public void setAllowGroupingChangeAtRuntime(boolean b)
Sets a boolean indicating whether the grouping is allowed to be changed at runtime.

Parameters:
b - true if the grouping is allowed to be changed.

isOutputDistinctRowsOnly

public boolean isOutputDistinctRowsOnly()
Returns a boolean indicating whether the duplicate rows should be skipped

Returns:
boolean

setOutputDistinctRowsOnly

public void setOutputDistinctRowsOnly(boolean b)
Sets a boolean indicating whether the duplicate rows should be skipped

Parameters:
b -

isSuppressDetailRows

public boolean isSuppressDetailRows()
Returns a boolean indicating whether server detail rows should be supporessed in the query output

Returns:
true if suppress detail rows is enabled

setSuppressDetailRows

public void setSuppressDetailRows(boolean b)
Set a boolean indicating whether detail rows will be suppressed from query result


getSummaryColumns

public java.util.Vector getSummaryColumns()
Returns the list of colums that are available for displaying in the summaries tab.

Returns:
The list of available summary columns

refreshSummaryColumns

public void refreshSummaryColumns()
Refreshes the list of available summary columns


updateSummaryColumns

public void updateSummaryColumns(java.util.Vector vector)
This method takes the function value from the summary columns vector passed and updates the one in the bean with this value. Each element in this list is an instance of SummaryBean.

Parameters:
vector - The list of summary columns

isAllowSummaryChangeAtRuntime

public boolean isAllowSummaryChangeAtRuntime()
Returns a boolean indicating whether the summary can be changed at runtime

Returns:
true if the summary can be changed

setAllowSummaryChangeAtRuntime

public void setAllowSummaryChangeAtRuntime(boolean b)
Specifies whether the summary is allowed to be changed at runtime

Parameters:
b - true if changing the summary is allowed.

isShowRowCountsInTotal

public boolean isShowRowCountsInTotal()
Returns a boolean indicating whether row counts should be shown in the query output.

Returns:
true if row counts are supposed to be shown.

setShowRowCountsInTotal

public void setShowRowCountsInTotal(boolean b)
Sets a boolean indicating whether row counts are supposed to be shown

Parameters:
b - true if row counts are supposed to be shown.

refreshGroups

public void refreshGroups()
Refreshes the group tree based on the selected columns


refreshSortColumns

public void refreshSortColumns()
Refreshes the list of sort columns based on the selected columns


updateGroupSortOrder

public void updateGroupSortOrder(java.util.List list)
Updates the sort order for the group nodes with the ones in the list passed Each item in the list is an instance of HtmlTreeNode with the data set to ASC/DESc

Parameters:
list - The list to update with

getSortableColumns

public java.util.Collection getSortableColumns()
Returns the columns that are available for sorting

Returns:
the list of sortable columns.

getSupportedQueryFeatures

public java.lang.String getSupportedQueryFeatures()
Returns a string indicating the supported Actuate Query features

Returns:
the supported query features.

getUiVersion

public java.lang.String getUiVersion()

getValueFromSupportedQueryFeaturesExtended

public java.lang.String getValueFromSupportedQueryFeaturesExtended(java.lang.String propertyName)

isGroupingEnabled

public boolean isGroupingEnabled()
Returns a boolean indicating whether grouping is enabled for this query object or not.

Returns:
true if grouping is enabled, false otherwise

isAnyGroupPresent

public boolean isAnyGroupPresent()
Checks to see if any grouping has been created for this query.

Returns:
true if any groups are present, false otherwise

isAnySummaryActive

public boolean isAnySummaryActive()
Checks to see if any summaries are currently active. Any columns that are added as groups will be inactive summaries.

Returns:
true if there are any active summaries.

setWritable

public void setWritable(boolean value)

getWritable

public boolean getWritable()
Returns false if user doesn't have write permission on query. Else, true.

Returns:
boolean