ScheduleObject (EspressReport 7.0 Java API

java.lang.Object
- quadbase.scheduler.ScheduleObject

All Implemented Interfaces:: java.io.Serializable

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

Represent a schedule task to be performed by the scheduler. A typical use of this class involves the following:

 
      // first connect to Espress Manager
      ScheduleModifier.connectServer(null);
 
      // allocate the ScheduleObject
 ScheduleObject sObj = new ScheduleObject("SCH_OBJ1", ScheduleObject.REPORTOBJ);
      // set the desired settings for this schedule task
 sObj.setFileLocation("Templates/SAMPLE.rpt");
 String exportLoc = sObj.pickDefaultExportLocation(); * 
 sObj.setReportType(IExportConstants.DHTML);
 sObj.setTaskOption(ScheduleObject.ONE_TIME);
 Calendar calendar = Calendar.getInstance();
 calendar.add(Calendar.MINUTE, 5);
 sObj.setStartDate(calendar.getTimeInMillis());
 sObj.setSendEmail(false);
 
      // add the task (ScheduleObject) to the scheduler
 ScheduleModifier.addScheduleTask(sObj);

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLBURSTING`
`static int`	`ASATTACHMENT` One of the constants returned by the method getEmailType() that specifies an email type.
`static int`	`ASHTML` One of the constants returned by the method getEmailType() that specifies an email type.
`static int`	`ASLINK` One of the constants returned by the method getEmailType() that specifies an email type.
`static int`	`CHARTOBJ` internal use only
`static int`	`COMMANDOBJ` One of the constants that specifies a type of schedule job
`static int`	`DAYS` One of the constants returned by the method getIntervalType() that specifies export time interval.
`static int`	`FIXED_DAYS` One of the constants returned by the method getTaskOption() that specifies a type of task.
`static int`	`GROUPBURSTING`
`static int`	`MONTHS` One of the constants returned by the method getIntervalType() that specifies export time interval.
`static int`	`NOBURSTING`
`static int`	`ONE_TIME` One of the constants returned by the method getTaskOption() that specifies a type of task.
`protected int`	`packageID`
`static int`	`PNG_COMPRESSSION_DEFAULT` internal use only
`static int`	`PNG_COMPRESSSION_FAST` internal use only
`static int`	`PNG_COMPRESSSION_MAX` internal use only
`static int`	`PNG_COMPRESSSION_NONE` internal use only
`static int`	`removeScheduleIconInterval`
`static int`	`REPORTOBJ` One of the constants that specifies a type of schedule job
`static int`	`TIME` One of the constants returned by the method getIntervalType() that specifies export time interval.
`static int`	`TIME_INTERVAL` One of the constants returned by the method getTaskOption() that specifies a type of task.
`static java.lang.String[]`	`TYPE` internal use only

Constructor Summary

Constructors
Constructor and Description
`ScheduleObject(ScheduleObject src)` internal use only
`ScheduleObject(java.lang.String name)` internal use only
`ScheduleObject(java.lang.String name, boolean isChartObject)` internal use only
`ScheduleObject(java.lang.String name, int type)` Creates ScheduleObject by providing schedule name and object type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static quadbase.reportdesigner.report.Report`	`createReport(java.lang.String urlPath, java.lang.String filePath)` internal use only
`boolean`	`deleteJob()` remove schedule job from the queue
`boolean`	`deleteJobPermanently(long curTime)`
`boolean`	`equals(ScheduleObject obj)` internal use only
`boolean`	`exportNow(long curTime)` internal use only
`java.lang.String`	`getBodyText()` For Email feature: Returns the body text of the email
`java.util.Hashtable`	`getBurstEmail()` internal use only
`int`	`getBurstReport()` returns what type of bursting has been applied (Burst All or Burst Group)
`java.lang.String`	`getChartLocation()` internal use only
`java.lang.String`	`getCommand()` Returns schedule command
`int`	`getDayInterval()` If task option is TIME_INTERVAL: Returns day interval in days
`int`	`getEmailColumnIndex()` returns the column index whose data provides the email addresses to send the exported reports to
`int`	`getEmailType()` For Email feature: Returns email type: ASATTACHMENT/ ASLINK/ ASHTML
`long`	`getEndDate()` If task option is TIME_INTERVAL / FIXEDDAYS: if endDate = -1, it runs indefinitely Returns end date for scheduled event
`int`	`getEndTime()` If task option is FIXEDDAYS Returns end time (in minutes) for scheduled event.
`java.lang.String`	`getExportLocation()` Returns export file location
`long`	`getExportTime()` internal use only
`int`	`getExportType()` internal use only
`java.lang.String`	`getExternalStyleSheetName()` For DHTML export: Returns the external style sheet file used for DHTML export.
`java.lang.String`	`getFailBodyText()` For Fail Job Email feature: returns the body text of the email
`java.lang.String`	`getFailSubject()` For Fail Job Email feature: returns the subject of the email
`java.lang.String`	`getFailToAddress()` For Fail Job Email feature: returns recievers' email addresses
`java.lang.String`	`getFileLocation()` Returns report file location
`java.lang.String`	`getFromAddress()` For Email feature: Returns sender email address
`java.lang.String`	`getFullID()` internal use only
`int`	`getID()` internal use only
`int`	`getImageHeight()` internal use only
`int`	`getImageWidth()` internal use only
`int`	`getIntervalType()` If task option is TIME_INTERVAL: Returns export time interval: TIME/ DAYS/ MONTHS
`int`	`getJPEGQuality()` internal use only
`int`	`getMonthInterval()` If task option is TIME_INTERVAL: Returns month interval in months
`java.lang.String`	`getName()` Returns schedule job name
`int`	`getNewLineDelimiter()` For TXT export: Returns the newline delimiter: IDelimiterConstants.WINDOWS_NEWLINE, IDelimiterConstants.MAC_NEWLINE, IDelimiterConstants.OTHERS_NEWLINE...
`int`	`getNextExportDay(int curDay, int[] specifyDays)` internal use only
`long`	`getNextExportTime()` Returns next export time in milliseconds
`int`	`getPackageID()` internal use only
`java.util.Hashtable`	`getParamAddresses()` For Param report/ chart Email feature: get hashtable for param set name (key), and email addresses (value) for example, "Param Set 1", new String[]{"peterL@quadbase.com", "HenryP@quadbase.com"}
`java.util.Vector<java.lang.Object[]>`	`getParamList()` Returns all the parameter set that have been defined for a schedule job that using param report.
`java.lang.String`	`getPDFOwnerPassword()` For PDF export: Returns the PDF owner password
`java.lang.String`	`getPDFUserPassword()` For PDF export: Returns the PDF user password
`int`	`getPNGCompression()` internal use only
`int`	`getPortNumber()` If it's a drilldown report, user has to enter port number for viewing sub-level report.
`java.lang.String`	`getReportLocation()` internal use only
`int`	`getReportType()` Returns exported report type: IExportConstants.PDF, IExportConstants.DHTML, IExportConstants.HTML...
`java.lang.String`	`getSecurityLevel()` Returns the report security level.
`java.lang.String`	`getServerName()` If it's a drilldown report, user has to enter server name for viewing sub-level report.
`java.lang.String`	`getServletDirectory()` If it's a drilldown report, user has to enter servlet directory for viewing sub-level report.
`int[]`	`getSpecifyDates()` If task option is FIXEDDAYS: Returns export file dates.
`int[]`	`getSpecifyDays()` If task option is FIXEDDAYS: Returns export file days
`int[]`	`getSpecifyTime()` If task option is FIXEDDAYS: Returns export file time (in minutes)
`long`	`getStartDate()` Returns start date for scheduled event in POSIX time.
`int`	`getStartTime()` If task option is FIXEDDAYS Returns start time (in minutes) for scheduled event.
`java.lang.String`	`getSubject()` For Email feature: Returns the subject of the email
`int`	`getTaskOption()` Returns task option: ONE_TIME - export once TIME_INTERVAL - export report after certain time interval FIXEDDAYS - only export report in certain fixed days/ dates
`int`	`getTextDelimiter()` For TXT and CSV export: Returns the text delimiter: IDelimiterConstants.TAB, IDelimiterConstants.SPACE, IDelimiterConstants.COMMA...
`int`	`getTimeInterval()` If task option is TIME_INTERVAL: Returns time interval in mins
`java.lang.String[]`	`getToAddresses()` For Email feature: Returns receivers' email addresses
`java.lang.String`	`getURLMapping()` For Email feature: If you elect to send a link to the generated report, you will need to specify an http path to the directory in which the report is generated.
`java.lang.String`	`getUserName()` internal use only
`boolean`	`isChart()` internal use only
`boolean`	`isCommand()` Returns whether it is schedule command object
`boolean`	`isEncodePDF()` For PDF export: Returns whether use encoding for DFT export
`boolean`	`isExportDay(int curDay, int[] specifyDays)` internal use only
`boolean`	`isExportToMultiPages()` DHTML/ HTML option: Returns whether export report to multi-pages
`boolean`	`isExportToSingleWPagination()` For DHTML/ HTML export: Exports return in one single page with pagination.
`boolean`	`isGIFTransparent()` internal use only
`boolean`	`isLimitExcelCellSplit()`
`boolean`	`isMemoryOptimized()` PDF / DHTML / HTML / CSV / TXT option: Returns whether using optimize memory export
`boolean`	`isReport()` Returns whether it is schedule report object
`static boolean`	`isRunMissedJob()` internal use only
`boolean`	`isSendEmail()` For Email feature: Returns whether email notification/delivery is used for the exported report
`boolean`	`isTimestampAttached()` This method will attach timestamp at the end of a file name in order to create new file everytime (instead of overwriting the file) It's useful feature for TIME_INTERVAL / FIXED_DAYS Returns whether attaching timestamp at the end of a file name
`boolean`	`isUseExternalStyleSheet()` For DHTML export: Returns whether use external style sheet for DHTML export
`boolean`	`isUseInternalStyleSheet()` For DHTML export: Returns whether use internal style sheet for DHTML export
`java.lang.String`	`pickDefaultExportLocation()` scheduler will pick default export file location Returns chosen file location
`void`	`print()` internal use only
`static ScheduleObject`	`read(java.io.DataInput orgIn, int version)` internal use only
`static ScheduleObject`	`readComplete(java.io.DataInput orgIn, int version)` internal use only
`void`	`resetExportTime()` internal use only
`void`	`setBodyText(java.lang.String bodyText)` For Email feature: specifies the body text of the email
`void`	`setBurstEmail(java.util.Hashtable table)` internal use only
`void`	`setBurstReport(int i)` sets the type of bursting to be applied (QbScheduleObject.ALLBURSTING or QbScheduleObject.GROUPBURSTING)
`void`	`setChart(boolean b)` internal use only
`void`	`setChartLocation(java.lang.String loc)` internal use only
`void`	`setCommand(java.lang.String cmd)` Specifies schedule command
`void`	`setDayInterval(int dayInt)` if task option is TIME_INTERVAL: specifies day interval in mins
`void`	`setDeleted()` internal use only
`void`	`setEmailColumnIndex(int i)` sets the column index whose data provides the email addresses to send the exported reports to
`void`	`setEmailType(int type)` For Email feature: specifies email type: ASATTACHMENT/ ASLINK/ ASHTML
`void`	`setEncodePDF(boolean b)` For PDF export: specifies whether use encoding for DFT export
`void`	`setEndDate(long eDate)` if task option is TIME_INTERVAL / FIXEDDAYS: if endDate = -1, it runs indefinitely specifies end date in millis second for scheduled event
`void`	`setEndTime(int edTime)` if task option is FIXEDDAYS: specifies end time for daily frequency feature
`void`	`setExportLocation(java.lang.String loc)` specifies export file location
`void`	`setExportTime(long time)` internal use only
`void`	`setExportToMultiPages(boolean b)` DHTML/ HTML option: specifies whether export report to multi-pages
`void`	`setExportToSingleWPagination(boolean b)` For DHTML/ HTML export: export return in one single page with pagination specifies state of exporting report to single page with pagination
`void`	`setExternalStyleSheetName(java.lang.String s)` For DHTML export: Specifies the external style sheet file used for DHTML export
`void`	`setFailBodyText(java.lang.String bodyTextFail)` For Fail Job Email feature: returns the body text of the email
`void`	`setFailSubject(java.lang.String subjectFail)` For Fail Job Email feature: returns the subject of the email
`void`	`setFailToAddress(java.lang.String toAddressFail)` For Fail Job Email feature: returns recievers' email addresses
`void`	`setFileLocation(java.lang.String loc)` specifies report file location
`void`	`setFromAddress(java.lang.String from)` For Email feature: specifies sender email address
`void`	`setGIFTransparent(boolean b)` internal use only
`void`	`setID(int id)` internal use only
`void`	`setImageHeight(int h)` internal use only
`void`	`setImageWidth(int w)` internal use only
`void`	`setIntervalType(int type)` if task option is TIME_INTERVAL: specifies export time interval: TIME/ DAYS/ MONTHS
`void`	`setJPEGQuality(int qual)` internal use only
`void`	`setLastExportFile(java.lang.String str)` internal use only
`void`	`setLimitExcelCellSplit(boolean limitExcelCellSplit)`
`void`	`setMemoryOptimized(boolean b)` report export option: specifies whether using optimize memory export
`void`	`setMonthInterval(int monInt)` if task option is TIME_INTERVAL: specifies month interval in mins
`void`	`setName(java.lang.String name)` Specifies schedule job name
`void`	`setNewLineDelimiter(int i)` For TXT export: specifies the newline delimiter: IDelimiterConstants.WINDOWS_NEWLINE, IDelimiterConstants.MAC_NEWLINE, IDelimiterConstants.OTHERS_NEWLINE...
`void`	`setPackageID(int packageID)` internal use only
`void`	`setParamAddresses(java.util.Hashtable table)` For Param report/ chart Email feature: create hashtable for param set name (key), and email addresses (value) for example, "Param Set 1", new String[]{"peterL@quadbase.com", "HenryP@quadbase.com"}
`void`	`setParamList(java.util.Vector paramList)` Specifies all the parameter set that have been defined for a schedule job that using param report.
`void`	`setParamList(java.util.Vector paramListName, java.util.Vector paramList)` specifies all the parameter set that have been defined for a schedule job that using param report.
`void`	`setPDFOwnerPassword(java.lang.String s)` For PDF export: specifies the PDF owner password
`void`	`setPDFUserPassword(java.lang.String s)` For PDF export: specifies the PDF user password
`void`	`setPNGCompression(int c)` internal use only
`void`	`setPortNumber(int pn)` If it's a drilldown report, user has to enter port number for viewing sub-level report specifies port number
`void`	`setReportLocation(java.lang.String loc)` internal use only
`void`	`setReportType(int type)` Specifies exported report type: IExportConstants.PDF, IExportConstants.DHTML, IExportConstants.HTML...
`static void`	`setRunMissedJob(boolean b)` internal use only
`void`	`setSecurityLevel(java.lang.String sl)` specifies the report security level If no security level is going to apply to the report, use a null string
`void`	`setSendEmail(boolean state)` For Email feature: specifies whether email notification/delivery is used for the exported report
`void`	`setServerName(java.lang.String sn)` If it's a drilldown report, user has to enter server name for viewing sub-level report specifies server name
`void`	`setServletDirectory(java.lang.String sd)` If it's a drilldown report, user has to enter servlet directory for viewing sub-level report specifies servlet directory
`void`	`setSpecifyDates(int[] dates)` if task option is FIXEDDAYS: Specifies export file dates.
`void`	`setSpecifyDays(int[] days)` if task option is FIXEDDAYS: specifies export file days
`void`	`setSpecifyTime(int[] time)` if task option is FIXEDDAYS: specifies export file time
`void`	`setStartDate(long sDate)` specifies start date for scheduled event
`void`	`setStartTime(int stTime)` if task option is FIXEDDAYS: specifies start time for daily frequency feature
`void`	`setSubject(java.lang.String subject)` For Email feature: specifies the subject of the email
`void`	`setTaskOption(int opt)` specifies task option: ONE_TIME - export once TIME_INTERVAL - export report after certain time interval FIXEDDAYS - only export report in certain fixed days/ dates
`void`	`setTextDelimiter(int i)` For TXT and CSV export: specifies the text delimiter: IDelimiterConstants.TAB, IDelimiterConstants.SPACE, IDelimiterConstants.COMMA...
`void`	`setTimeInterval(int timeInt)` if task option is TIME_INTERVAL: specifies time interval in mins
`void`	`setTimestampAttached(boolean attach)` This method will attach timestamp at the end of a file name in order to create new file everytime (instead of overwriting the file).
`void`	`setToAddresses(java.lang.String[] to)` For Email feature: specifies receivers' email addresses
`void`	`setURLMapping(java.lang.String urlMapping)` For Email feature: If you elect to send a link to the generated report, you will need to specify an http path to the directory in which the report is generated.
`void`	`setUseExternalStyleSheet(boolean b)` For DHTML export: specifies whether use external style sheet for DHTML export
`void`	`setUseInternalStyleSheet(boolean b)` For DHTML export: specifies whether use internal style sheet for DHTML export
`void`	`setUserName(java.lang.String name)` internal use only
`boolean`	`updateTime()`
`void`	`write(java.io.DataOutput orgOut)` internal use only
`void`	`writeComplete(java.io.DataOutput orgOut)` internal use only

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHARTOBJ
```
public static final int CHARTOBJ
```
    internal use only
    
    See Also:
    
    Constant Field Values
  - REPORTOBJ
```
public static final int REPORTOBJ
```
    One of the constants that specifies a type of schedule job
    
    See Also:
    
    Constant Field Values
  - COMMANDOBJ
```
public static final int COMMANDOBJ
```
    One of the constants that specifies a type of schedule job
    
    See Also:
    
    Constant Field Values
  - PNG_COMPRESSSION_DEFAULT
```
public static final int PNG_COMPRESSSION_DEFAULT
```
    internal use only
    
    See Also:
    
    Constant Field Values
  - PNG_COMPRESSSION_FAST
```
public static final int PNG_COMPRESSSION_FAST
```
    internal use only
    
    See Also:
    
    Constant Field Values
  - PNG_COMPRESSSION_MAX
```
public static final int PNG_COMPRESSSION_MAX
```
    internal use only
    
    See Also:
    
    Constant Field Values
  - PNG_COMPRESSSION_NONE
```
public static final int PNG_COMPRESSSION_NONE
```
    internal use only
    
    See Also:
    
    Constant Field Values
  - removeScheduleIconInterval
```
public static final int removeScheduleIconInterval
```
    See Also:
    
    Constant Field Values
  - ASATTACHMENT
```
public static final int ASATTACHMENT
```
    One of the constants returned by the method getEmailType() that specifies an email type.
    
    See Also:
    
    Constant Field Values
  - ASLINK
```
public static final int ASLINK
```
    One of the constants returned by the method getEmailType() that specifies an email type.
    
    See Also:
    
    Constant Field Values
  - ASHTML
```
public static final int ASHTML
```
    One of the constants returned by the method getEmailType() that specifies an email type.
    
    See Also:
    
    Constant Field Values
  - ONE_TIME
```
public static final int ONE_TIME
```
    One of the constants returned by the method getTaskOption() that specifies a type of task.
    
    See Also:
    
    Constant Field Values
  - TIME_INTERVAL
```
public static final int TIME_INTERVAL
```
    One of the constants returned by the method getTaskOption() that specifies a type of task.
    
    See Also:
    
    Constant Field Values
  - FIXED_DAYS
```
public static final int FIXED_DAYS
```
    One of the constants returned by the method getTaskOption() that specifies a type of task.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final java.lang.String[] TYPE
```
    internal use only
  - TIME
```
public static final int TIME
```
    One of the constants returned by the method getIntervalType() that specifies export time interval.
    
    See Also:
    
    Constant Field Values
  - DAYS
```
public static final int DAYS
```
    One of the constants returned by the method getIntervalType() that specifies export time interval.
    
    See Also:
    
    Constant Field Values
  - MONTHS
```
public static final int MONTHS
```
    One of the constants returned by the method getIntervalType() that specifies export time interval.
    
    See Also:
    
    Constant Field Values
  - NOBURSTING
```
public static int NOBURSTING
```
  - GROUPBURSTING
```
public static int GROUPBURSTING
```
  - ALLBURSTING
```
public static int ALLBURSTING
```
  - packageID
```
protected int packageID
```
- Constructor Detail
  - ScheduleObject
```
public ScheduleObject(java.lang.String name)
```
    internal use only
  - ScheduleObject
```
public ScheduleObject(java.lang.String name,
                      boolean isChartObject)
```
    internal use only
  - ScheduleObject
```
public ScheduleObject(ScheduleObject src)
```
    internal use only
  - ScheduleObject
```
public ScheduleObject(java.lang.String name,
                      int type)
```
    Creates ScheduleObject by providing schedule name and object type
    
    Parameters:
    
    name - schedule job name
    
    type - object type: REPORTOBJ / COMMANDOBJ
- Method Detail
  - isRunMissedJob
```
public static boolean isRunMissedJob()
```
    internal use only
  - setRunMissedJob
```
public static void setRunMissedJob(boolean b)
```
    internal use only
  - createReport
```
public static quadbase.reportdesigner.report.Report createReport(java.lang.String urlPath,
                                                                 java.lang.String filePath)
```
    internal use only
  - read
```
public static ScheduleObject read(java.io.DataInput orgIn,
                                  int version)
                           throws java.lang.Exception
```
    internal use only
    
    Throws:
    
    java.lang.Exception
  - readComplete
```
public static ScheduleObject readComplete(java.io.DataInput orgIn,
                                          int version)
                                   throws java.lang.Exception
```
    internal use only
    
    Throws:
    
    java.lang.Exception
  - print
```
public void print()
```
    internal use only
  - isChart
```
public boolean isChart()
```
    internal use only
  - setChart
```
public void setChart(boolean b)
```
    internal use only
  - isReport
```
public boolean isReport()
```
    Returns whether it is schedule report object
  - isCommand
```
public boolean isCommand()
```
    Returns whether it is schedule command object
  - getName
```
public java.lang.String getName()
```
    Returns schedule job name
  - setName
```
public void setName(java.lang.String name)
```
    Specifies schedule job name
  - getID
```
public int getID()
```
    internal use only
  - setID
```
public void setID(int id)
```
    internal use only
  - getPackageID
```
public int getPackageID()
```
    internal use only
  - setPackageID
```
public void setPackageID(int packageID)
```
    internal use only
  - getFullID
```
public java.lang.String getFullID()
```
    internal use only
  - getReportType
```
public int getReportType()
```
    Returns exported report type: IExportConstants.PDF, IExportConstants.DHTML, IExportConstants.HTML...
    
    See Also:
    
    IExportConstants
  - setReportType
```
public void setReportType(int type)
```
    Specifies exported report type: IExportConstants.PDF, IExportConstants.DHTML, IExportConstants.HTML...
    
    See Also:
    
    IExportConstants
  - getExportType
```
public int getExportType()
```
    internal use only
  - getJPEGQuality
```
public int getJPEGQuality()
```
    internal use only
  - setJPEGQuality
```
public void setJPEGQuality(int qual)
```
    internal use only
  - isGIFTransparent
```
public boolean isGIFTransparent()
```
    internal use only
  - setGIFTransparent
```
public void setGIFTransparent(boolean b)
```
    internal use only
  - getPNGCompression
```
public int getPNGCompression()
```
    internal use only
  - setPNGCompression
```
public void setPNGCompression(int c)
```
    internal use only
  - getImageWidth
```
public int getImageWidth()
```
    internal use only
  - setImageWidth
```
public void setImageWidth(int w)
```
    internal use only
  - getImageHeight
```
public int getImageHeight()
```
    internal use only
  - setImageHeight
```
public void setImageHeight(int h)
```
    internal use only
  - getFileLocation
```
public java.lang.String getFileLocation()
```
    Returns report file location
  - setFileLocation
```
public void setFileLocation(java.lang.String loc)
```
    specifies report file location
  - getChartLocation
```
public java.lang.String getChartLocation()
```
    internal use only
  - setChartLocation
```
public void setChartLocation(java.lang.String loc)
```
    internal use only
  - getReportLocation
```
public java.lang.String getReportLocation()
```
    internal use only
  - setReportLocation
```
public void setReportLocation(java.lang.String loc)
```
    internal use only
  - getExportLocation
```
public java.lang.String getExportLocation()
```
    Returns export file location
  - setExportLocation
```
public void setExportLocation(java.lang.String loc)
```
    specifies export file location
  - getCommand
```
public java.lang.String getCommand()
```
    Returns schedule command
  - setCommand
```
public void setCommand(java.lang.String cmd)
```
    Specifies schedule command
  - getTaskOption
```
public int getTaskOption()
```
    Returns task option:
    ONE_TIME - export once
    TIME_INTERVAL - export report after certain time interval
    FIXEDDAYS - only export report in certain fixed days/ dates
  - setTaskOption
```
public void setTaskOption(int opt)
```
    specifies task option: ONE_TIME - export once TIME_INTERVAL - export report after certain time interval FIXEDDAYS - only export report in certain fixed days/ dates
  - getSpecifyDates
```
public int[] getSpecifyDates()
```
    If task option is FIXEDDAYS: Returns export file dates. The dates are in the format of integers representing the dates of the month.
    For example, {1,10,20} would run on the 1st, 10th, and 20th of the month.
  - setSpecifyDates
```
public void setSpecifyDates(int[] dates)
```
    if task option is FIXEDDAYS: Specifies export file dates. The dates are in the format of integers representing the dates of the month.
    For example, {1,10,20} would run on the 1st, 10th, and 20th of the month.
  - getSpecifyDays
```
public int[] getSpecifyDays()
```
    If task option is FIXEDDAYS: Returns export file days
  - setSpecifyDays
```
public void setSpecifyDays(int[] days)
```
    if task option is FIXEDDAYS: specifies export file days
  - getSpecifyTime
```
public int[] getSpecifyTime()
```
    If task option is FIXEDDAYS: Returns export file time (in minutes)
  - setSpecifyTime
```
public void setSpecifyTime(int[] time)
```
    if task option is FIXEDDAYS: specifies export file time
  - getStartDate
```
public long getStartDate()
```
    Returns start date for scheduled event in POSIX time.
  - setStartDate
```
public void setStartDate(long sDate)
```
    specifies start date for scheduled event
  - getEndDate
```
public long getEndDate()
```
    If task option is TIME_INTERVAL / FIXEDDAYS: if endDate = -1, it runs indefinitely Returns end date for scheduled event
  - setEndDate
```
public void setEndDate(long eDate)
```
    if task option is TIME_INTERVAL / FIXEDDAYS: if endDate = -1, it runs indefinitely specifies end date in millis second for scheduled event
  - getIntervalType
```
public int getIntervalType()
```
    If task option is TIME_INTERVAL: Returns export time interval: TIME/ DAYS/ MONTHS
  - setIntervalType
```
public void setIntervalType(int type)
```
    if task option is TIME_INTERVAL: specifies export time interval: TIME/ DAYS/ MONTHS
  - getStartTime
```
public int getStartTime()
```
    If task option is FIXEDDAYS Returns start time (in minutes) for scheduled event.
  - setStartTime
```
public void setStartTime(int stTime)
```
    if task option is FIXEDDAYS: specifies start time for daily frequency feature
  - getEndTime
```
public int getEndTime()
```
    If task option is FIXEDDAYS Returns end time (in minutes) for scheduled event.
  - setEndTime
```
public void setEndTime(int edTime)
```
    if task option is FIXEDDAYS: specifies end time for daily frequency feature
  - getTimeInterval
```
public int getTimeInterval()
```
    If task option is TIME_INTERVAL: Returns time interval in mins
  - setTimeInterval
```
public void setTimeInterval(int timeInt)
```
    if task option is TIME_INTERVAL: specifies time interval in mins
  - getMonthInterval
```
public int getMonthInterval()
```
    If task option is TIME_INTERVAL: Returns month interval in months
  - setMonthInterval
```
public void setMonthInterval(int monInt)
```
    if task option is TIME_INTERVAL: specifies month interval in mins
  - getDayInterval
```
public int getDayInterval()
```
    If task option is TIME_INTERVAL: Returns day interval in days
  - setDayInterval
```
public void setDayInterval(int dayInt)
```
    if task option is TIME_INTERVAL: specifies day interval in mins
  - getUserName
```
public java.lang.String getUserName()
```
    internal use only
  - setUserName
```
public void setUserName(java.lang.String name)
```
    internal use only
  - getBurstReport
```
public int getBurstReport()
```
    returns what type of bursting has been applied (Burst All or Burst Group)
  - setBurstReport
```
public void setBurstReport(int i)
```
    sets the type of bursting to be applied (QbScheduleObject.ALLBURSTING or QbScheduleObject.GROUPBURSTING)
  - isExportToMultiPages
```
public boolean isExportToMultiPages()
```
    DHTML/ HTML option: Returns whether export report to multi-pages
  - setExportToMultiPages
```
public void setExportToMultiPages(boolean b)
```
    DHTML/ HTML option: specifies whether export report to multi-pages
  - isMemoryOptimized
```
public boolean isMemoryOptimized()
```
    PDF / DHTML / HTML / CSV / TXT option: Returns whether using optimize memory export
  - setMemoryOptimized
```
public void setMemoryOptimized(boolean b)
```
    report export option: specifies whether using optimize memory export
  - getParamList
```
public java.util.Vector<java.lang.Object[]> getParamList()
```
    Returns all the parameter set that have been defined for a schedule job that using param report. Each element of Vector is an Object[] which contains the query/formula parameter value. For example,
    If report contains 3 parameters: STATE(String), DRINK(String - MULTI-PARAM), QUANTITY (Integer)
    And there's 2 parameter set:
    [CA], [Coffee, Water], 50
    [NY], [Juice, Soda, Tea], 100
    The param list should be:
    Vector set0_Param1 = new Vector();
    set0_Param1.addELement("Coffee");
    set0_Param1.addELement("Water");
    Object[] set0 = new Object[]{"CA", set0_Param1, Integer.valueOf(50)};
    Vector set1_Param1 = new Vector();
    set1_Param1.addELement("Juice");
    set1_Param1.addELement("Soda");
    set1_Param1.addELement("Tea");
    Object[] set1 = new Object[]{"NY", set1_Param1, Integer.valueOf(100)};
    Vector paramList = new Vector();
    paramList.addElement(set0);
    paramList.addElement(set1);
  - setParamList
```
public void setParamList(java.util.Vector paramList)
```
    Specifies all the parameter set that have been defined for a schedule job that using param report. Each element of Vector is an Object[] which contains the query/formula parameter value.
```
 For example,
 if report contains 3 parameters: STATE(String), DRINK(String - MULTI-PARAM), QUANTITY (Integer)

  And there's 2 parameter set:
 [CA], [Coffee, Water], 50
  [NY], [Juice, Soda, Tea], 100

  The param list should be:
  Vector set0_Param1 = new Vector();
  set0_Param1.addELement("Coffee");
  set0_Param1.addELement("Water");
  Object[] set0 = new Object[]{"CA", set0_Param1, Integer.valueOf(50)};
  Vector set1_Param1 = new Vector();
  set1_Param1.addELement("Juice");
  set1_Param1.addELement("Soda");
  set1_Param1.addELement("Tea");
  Object[] set1 = new Object[]{"NY", set1_Param1, Integer.valueOf(100)};
  Vector paramList = new Vector();
  paramList.addElement(set0);
  paramList.addElement(set1);
 
```
    Parameters:
    
    paramList - a list of parameter values according to the above structure. Pass in null to "Select All" possible values if and only if the parameters have been set to map to a database column.
  - isSendEmail
```
public boolean isSendEmail()
```
    For Email feature: Returns whether email notification/delivery is used for the exported report
  - setSendEmail
```
public void setSendEmail(boolean state)
```
    For Email feature: specifies whether email notification/delivery is used for the exported report
  - getFromAddress
```
public java.lang.String getFromAddress()
```
    For Email feature: Returns sender email address
  - setFromAddress
```
public void setFromAddress(java.lang.String from)
```
    For Email feature: specifies sender email address
  - getToAddresses
```
public java.lang.String[] getToAddresses()
```
    For Email feature: Returns receivers' email addresses
  - setToAddresses
```
public void setToAddresses(java.lang.String[] to)
```
    For Email feature: specifies receivers' email addresses
  - getSubject
```
public java.lang.String getSubject()
```
    For Email feature: Returns the subject of the email
  - setSubject
```
public void setSubject(java.lang.String subject)
```
    For Email feature: specifies the subject of the email
  - getBodyText
```
public java.lang.String getBodyText()
```
    For Email feature: Returns the body text of the email
  - setBodyText
```
public void setBodyText(java.lang.String bodyText)
```
    For Email feature: specifies the body text of the email
  - getFailSubject
```
public java.lang.String getFailSubject()
```
    For Fail Job Email feature: returns the subject of the email
  - setFailSubject
```
public void setFailSubject(java.lang.String subjectFail)
```
    For Fail Job Email feature: returns the subject of the email
  - getFailBodyText
```
public java.lang.String getFailBodyText()
```
    For Fail Job Email feature: returns the body text of the email
  - setFailBodyText
```
public void setFailBodyText(java.lang.String bodyTextFail)
```
    For Fail Job Email feature: returns the body text of the email
  - getFailToAddress
```
public java.lang.String getFailToAddress()
```
    For Fail Job Email feature: returns recievers' email addresses
  - setFailToAddress
```
public void setFailToAddress(java.lang.String toAddressFail)
```
    For Fail Job Email feature: returns recievers' email addresses
  - getEmailType
```
public int getEmailType()
```
    For Email feature: Returns email type: ASATTACHMENT/ ASLINK/ ASHTML
  - setEmailType
```
public void setEmailType(int type)
```
    For Email feature: specifies email type: ASATTACHMENT/ ASLINK/ ASHTML
  - getURLMapping
```
public java.lang.String getURLMapping()
```
    For Email feature: If you elect to send a link to the generated report, you will need to specify an http path to the directory in which the report is generated. Otherwise, the link will not form correctly. Returns the url mapping
  - setURLMapping
```
public void setURLMapping(java.lang.String urlMapping)
```
    For Email feature: If you elect to send a link to the generated report, you will need to specify an http path to the directory in which the report is generated. Otherwise, the link will not form correctly. specifies the url mapping
  - getSecurityLevel
```
public java.lang.String getSecurityLevel()
```
    Returns the report security level. If no security level is going to apply to the report, it'll returns null
  - setSecurityLevel
```
public void setSecurityLevel(java.lang.String sl)
```
    specifies the report security level If no security level is going to apply to the report, use a null string
  - getServerName
```
public java.lang.String getServerName()
```
    If it's a drilldown report, user has to enter server name for viewing sub-level report. Returns server name
  - setServerName
```
public void setServerName(java.lang.String sn)
```
    If it's a drilldown report, user has to enter server name for viewing sub-level report specifies server name
  - getPortNumber
```
public int getPortNumber()
```
    If it's a drilldown report, user has to enter port number for viewing sub-level report. Returns port number
  - setPortNumber
```
public void setPortNumber(int pn)
```
    If it's a drilldown report, user has to enter port number for viewing sub-level report specifies port number
  - getServletDirectory
```
public java.lang.String getServletDirectory()
```
    If it's a drilldown report, user has to enter servlet directory for viewing sub-level report. Returns servlet directory
  - setServletDirectory
```
public void setServletDirectory(java.lang.String sd)
```
    If it's a drilldown report, user has to enter servlet directory for viewing sub-level report specifies servlet directory
  - isExportToSingleWPagination
```
public boolean isExportToSingleWPagination()
```
    For DHTML/ HTML export: Exports return in one single page with pagination. Returns state of exporting report to single page with pagination.
  - setExportToSingleWPagination
```
public void setExportToSingleWPagination(boolean b)
```
    For DHTML/ HTML export: export return in one single page with pagination specifies state of exporting report to single page with pagination
  - isUseInternalStyleSheet
```
public boolean isUseInternalStyleSheet()
```
    For DHTML export: Returns whether use internal style sheet for DHTML export
  - setUseInternalStyleSheet
```
public void setUseInternalStyleSheet(boolean b)
```
    For DHTML export: specifies whether use internal style sheet for DHTML export
  - isUseExternalStyleSheet
```
public boolean isUseExternalStyleSheet()
```
    For DHTML export: Returns whether use external style sheet for DHTML export
  - setUseExternalStyleSheet
```
public void setUseExternalStyleSheet(boolean b)
```
    For DHTML export: specifies whether use external style sheet for DHTML export
  - getExternalStyleSheetName
```
public java.lang.String getExternalStyleSheetName()
```
    For DHTML export: Returns the external style sheet file used for DHTML export. Returns the name of the external style sheet
  - setExternalStyleSheetName
```
public void setExternalStyleSheetName(java.lang.String s)
```
    For DHTML export: Specifies the external style sheet file used for DHTML export
    
    Parameters:
    
    s - the name of the external style sheet
  - isEncodePDF
```
public boolean isEncodePDF()
```
    For PDF export: Returns whether use encoding for DFT export
  - setEncodePDF
```
public void setEncodePDF(boolean b)
```
    For PDF export: specifies whether use encoding for DFT export
  - getPDFUserPassword
```
public java.lang.String getPDFUserPassword()
```
    For PDF export: Returns the PDF user password
  - setPDFUserPassword
```
public void setPDFUserPassword(java.lang.String s)
```
    For PDF export: specifies the PDF user password
  - getPDFOwnerPassword
```
public java.lang.String getPDFOwnerPassword()
```
    For PDF export: Returns the PDF owner password
  - setPDFOwnerPassword
```
public void setPDFOwnerPassword(java.lang.String s)
```
    For PDF export: specifies the PDF owner password
  - getTextDelimiter
```
public int getTextDelimiter()
```
    For TXT and CSV export: Returns the text delimiter: IDelimiterConstants.TAB, IDelimiterConstants.SPACE, IDelimiterConstants.COMMA...
    
    See Also:
    
    IDelimiterConstants
  - setTextDelimiter
```
public void setTextDelimiter(int i)
```
    For TXT and CSV export: specifies the text delimiter: IDelimiterConstants.TAB, IDelimiterConstants.SPACE, IDelimiterConstants.COMMA...
    
    See Also:
    
    IDelimiterConstants
  - getNewLineDelimiter
```
public int getNewLineDelimiter()
```
    For TXT export: Returns the newline delimiter: IDelimiterConstants.WINDOWS_NEWLINE, IDelimiterConstants.MAC_NEWLINE, IDelimiterConstants.OTHERS_NEWLINE...
    
    See Also:
    
    IDelimiterConstants
  - setNewLineDelimiter
```
public void setNewLineDelimiter(int i)
```
    For TXT export: specifies the newline delimiter: IDelimiterConstants.WINDOWS_NEWLINE, IDelimiterConstants.MAC_NEWLINE, IDelimiterConstants.OTHERS_NEWLINE...
    
    See Also:
    
    IDelimiterConstants
  - isTimestampAttached
```
public boolean isTimestampAttached()
```
    This method will attach timestamp at the end of a file name in order to create new file everytime (instead of overwriting the file) It's useful feature for TIME_INTERVAL / FIXED_DAYS Returns whether attaching timestamp at the end of a file name
  - setTimestampAttached
```
public void setTimestampAttached(boolean attach)
```
    This method will attach timestamp at the end of a file name in order to create new file everytime (instead of overwriting the file). It's useful feature for TIME_INTERVAL / FIXED_DAYS specifies attaching timestamp at the end of a file name
  - getParamAddresses
```
public java.util.Hashtable getParamAddresses()
```
    For Param report/ chart Email feature: get hashtable for param set name (key), and email addresses (value) for example, "Param Set 1", new String[]{"peterL@quadbase.com", "HenryP@quadbase.com"}
  - setParamAddresses
```
public void setParamAddresses(java.util.Hashtable table)
```
    For Param report/ chart Email feature: create hashtable for param set name (key), and email addresses (value) for example, "Param Set 1", new String[]{"peterL@quadbase.com", "HenryP@quadbase.com"}
  - getBurstEmail
```
public java.util.Hashtable getBurstEmail()
```
    internal use only
  - setBurstEmail
```
public void setBurstEmail(java.util.Hashtable table)
```
    internal use only
  - getEmailColumnIndex
```
public int getEmailColumnIndex()
```
    returns the column index whose data provides the email addresses to send the exported reports to
  - setEmailColumnIndex
```
public void setEmailColumnIndex(int i)
```
    sets the column index whose data provides the email addresses to send the exported reports to
  - pickDefaultExportLocation
```
public java.lang.String pickDefaultExportLocation()
                                           throws java.lang.Exception
```
    scheduler will pick default export file location Returns chosen file location
    
    Throws:
    
    java.lang.Exception
  - setParamList
```
public void setParamList(java.util.Vector paramListName,
                         java.util.Vector paramList)
```
```
 specifies all the parameter set that have been defined for a schedule job
 that using param report.  Each element of Vector is an Object[] which
 contains the query/formula parameter value.
 For example,
 if report contains 3 parameters: STATE(String), DRINK(String - MULTI-PARAM),
 QUANTITY (Integer)
 And there's 2 parameter set:
 [CA], [Coffee, Water], 50
 [NY], [Juice, Soda, Tea], 100
 
 The param list should be:
 Vector set0_Param1 = new Vector();
 set0_Param1.addELement("Coffee");
 set0_Param1.addELement("Water");
 Object[] set0 = new Object[]{"CA", set0_Param1, Integer.valueOf(50)};
 Vector set1_Param1 = new Vector();
 set1_Param1.addELement("Juice");
 set1_Param1.addELement("Soda");
 set1_Param1.addELement("Tea");
 Object[] set1 = new Object[]{"NY", set1_Param1, Integer.valueOf(100)};
 Vector paramList = new Vector();
 paramList.addElement(set0);
 paramList.addElement(set1);
 
```
    Parameters:
    
    paramList - a list of parameter values according to the above structure. Pass in null to "Select All" possible values if and only if the parameters have been set to map to a database column.
  - setLastExportFile
```
public void setLastExportFile(java.lang.String str)
```
    internal use only
  - setDeleted
```
public void setDeleted()
```
    internal use only
  - getExportTime
```
public long getExportTime()
```
    internal use only
  - setExportTime
```
public void setExportTime(long time)
```
    internal use only
  - resetExportTime
```
public void resetExportTime()
```
    internal use only
  - getNextExportTime
```
public long getNextExportTime()
```
    Returns next export time in milliseconds
  - exportNow
```
public boolean exportNow(long curTime)
```
    internal use only
  - deleteJob
```
public boolean deleteJob()
```
    remove schedule job from the queue
  - deleteJobPermanently
```
public boolean deleteJobPermanently(long curTime)
```
  - updateTime
```
public boolean updateTime()
```
  - isExportDay
```
public boolean isExportDay(int curDay,
                           int[] specifyDays)
```
    internal use only
  - getNextExportDay
```
public int getNextExportDay(int curDay,
                            int[] specifyDays)
```
    internal use only
  - equals
```
public boolean equals(ScheduleObject obj)
```
    internal use only
  - write
```
public void write(java.io.DataOutput orgOut)
           throws java.lang.Exception
```
    internal use only
    
    Throws:
    
    java.lang.Exception
  - writeComplete
```
public void writeComplete(java.io.DataOutput orgOut)
                   throws java.lang.Exception
```
    internal use only
    
    Throws:
    
    java.lang.Exception
  - isLimitExcelCellSplit
```
public boolean isLimitExcelCellSplit()
```
  - setLimitExcelCellSplit
```
public void setLimitExcelCellSplit(boolean limitExcelCellSplit)
```

Class ScheduleObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CHARTOBJ

REPORTOBJ

COMMANDOBJ

PNG_COMPRESSSION_DEFAULT

PNG_COMPRESSSION_FAST

PNG_COMPRESSSION_MAX

PNG_COMPRESSSION_NONE

removeScheduleIconInterval

ASATTACHMENT

ASLINK

ASHTML

ONE_TIME

TIME_INTERVAL

FIXED_DAYS

TYPE

TIME

DAYS

MONTHS

NOBURSTING

GROUPBURSTING

ALLBURSTING

packageID

Constructor Detail

ScheduleObject

ScheduleObject

ScheduleObject

ScheduleObject

Method Detail

isRunMissedJob

setRunMissedJob

createReport

read

readComplete

print

isChart

setChart

isReport

isCommand

getName

setName

getID

setID

getPackageID

setPackageID

getFullID

getReportType

setReportType

getExportType

getJPEGQuality

setJPEGQuality

isGIFTransparent

setGIFTransparent

getPNGCompression

setPNGCompression

getImageWidth

setImageWidth

getImageHeight

setImageHeight

getFileLocation

setFileLocation

getChartLocation

setChartLocation

getReportLocation

setReportLocation

getExportLocation

setExportLocation

getCommand

setCommand

getTaskOption

setTaskOption

getSpecifyDates

setSpecifyDates

getSpecifyDays

setSpecifyDays