Package quadbase.reportorganizer.organizerAPI

Class QbSchedulePackage

java.lang.Object
quadbase.reportorganizer.organizerAPI.QbSchedulePackage
public class QbSchedulePackage extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ASATTACHMENT
    One of the constants returned by the method getEmailType() that specifies an email type.
    static final int
    ASHTML
    One of the constants returned by the method getEmailType() that specifies an email type.
    static final int
    ASLINK
    Deprecated.
    Use runtime variable instead
    static final int
    DAYS
    One of the constants returned by the method getIntervalType() that specifies export time interval.
    static final int
    FIXED_DAYS
    One of the constants returned by the method getTaskOption() that specifies a type of task.
    static final int
    MONTHS
    One of the constants returned by the method getIntervalType() that specifies export time interval.
    static final int
    NONE
    One of the constants returned by the method getEmailType() that specifies an email type.
    static final int
    ONE_TIME
    One of the constants returned by the method getTaskOption() that specifies a type of task.
    static final int
    PNG_COMPRESSION_DEFAULT
    One of the constants returned by the method getPNGCompression() that specifies png compression.
    static final int
    PNG_COMPRESSION_FAST
    One of the constants returned by the method getPNGCompression() that specifies png compression.
    static final int
    PNG_COMPRESSION_MAX
    One of the constants returned by the method getPNGCompression() that specifies png compression.
    static final int
    PNG_COMPRESSION_NONE
    One of the constants returned by the method getPNGCompression() that specifies png compression.
    static final int
    TIME
    One of the constants returned by the method getIntervalType() that specifies export time interval.
    static final int
    TIME_INTERVAL
    One of the constants returned by the method getTaskOption() that specifies a type of task.

  • Constructor Summary

    Constructors
    Constructor
    Description
    QbSchedulePackage(String name, QbOrganizer organizer)
     
    QbSchedulePackage(quadbase.reportorganizer.data.SchedulePackage schedulePackage)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addScheduleObject(QbScheduleObject sObj)
     
    boolean
    deleteJob()
    remove schedule job from the queue
    Vector
    getAllScheduleObjects()
    returns Vector of all QbScheduleObjects in this package
    String
    getBodyText()
    For Email feature: returns the body text of the email
    int
    getChartExportType()
    returns exported chart type: IExportConstants.JPEG, IExportConstants.GIF, IExportConstants.PNG...
    int
    getDayInterval()
    if task option is TIME_INTERVAL: returns day interval in days
    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()
    returns end time for daily frequency feature
    long
    getExportTime()
     
    String
    getExternalStyleSheetName()
    For DHTML export: Specifies the external style sheet file used for DHTML export returns the name of the external style sheet
    String
    getFailBodyText()
    For Fail Job Email feature: returns the body text of the email
    String
    getFailSubject()
    For Fail Job Email feature: returns the subject of the email
    String
    getFailToAddress()
    For Fail Job Email feature: returns receivers' email addresses
    String
    getFromAddress()
    For Email feature: returns sender email address
    String
    getFtpFilePath()
    returns FTP file path
    String
    getFtpHost()
    returns FTP host
    String
    getFtpPassword()
    returns FTP password
    String
    getFtpUserName()
    returns FTP user name
    int
    getImageHeight()
    returns exported image height
    int
    getImageWidth()
    returns exported image width
    int
    getIntervalType()
    if task option is TIME_INTERVAL: returns export time interval: TIME/ DAYS/ MONTHS
    int
    getJpegQuality()
    returns JPEG file quality
    int
    getMonthInterval()
    if task option is TIME_INTERVAL: returns month interval in months
    String
    getName()
     
    int
    getNewLineDelimiter()
     
    long
    getNextExportTime()
    return next export time in millisecond
    String
    getOwnerId()
     
    String
    getPdfOwnerPassword()
    For PDF export: returns the PDF owner password
    String
    getPdfUserPassword()
    For PDF export: returns the PDF user password
    int
    getPngCompression()
    returns PNG compression
    int
    getPrintFromPage()
    PRINTING: get "from" page
    int
    getPrintToPage()
    PRINTING: get "to" page
    int
    getReportExportType()
    returns exported report type: IExportConstants.PDF, IExportConstants.DHTML, IExportConstants.HTML...
    QbScheduleObject
    getScheduleObjectById(int scheduleId)
     
    String
    getSelectedPrinter()
    returns selected printer
    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 minute for daily frequency feature
    long
    getStartDate()
    returns start date for scheduled event
    long
    getStartExportTime()
     
    int
    getStartTime()
    returns start time for daily frequency feature
    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, IDelimiterConstanst.SPACE, IDelimiterConstant.COMMA...
    int
    getTimeInterval()
    if task option is TIME_INTERVAL: returns time interval in mins
    String
    getUserName()
     
    boolean
    isArchive()
    returns whether it is archive job
    boolean
    isEncodePdf()
    For PDF export: returns whether use encoding for DFT export
    boolean
    isExportToMultiPages()
    DHTML/ HTML option: returns whether export report to multi-pages
    boolean
    isExportToSingleWPagination()
    For DHTML/ HTML export: export return in one single page with pagination returns state of exporting report to single page with pagination
    boolean
    isFtpDelivery()
     
    boolean
    isGifTransparent()
    returns whether the gif file export contains transparent background
    boolean
    isMemoryOptimized()
    DHTML/ HTML option: returns whether using optimize memory export
    boolean
    isOwnerGroup()
     
    boolean
    isPrinterDelivery()
    returns whether using printer delivery
    boolean
    isSendEmail()
    For Email feature: returns whether email notification/delivery is used for the exported report
    boolean
    isTimestampAttached()
    returns whether timestamp is attached to export location
    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
    void
    removeScheduleObject(QbScheduleObject sObj)
     
    void
    setArchive(boolean isArchive)
    set archive job
    void
    setBodyText(String bodyText)
    For Email feature: specifies the body text of the email
    void
    setChartExportType(int type)
    specifies exported chart type: IExportConstants.JPEG, IExportConstants.GIF, IExportConstants.PNG...
    void
    setDayInterval(int dayInterval)
    if task option is TIME_INTERVAL: specifies day interval in mins
    void
    setEmailType(int emailType)
    For Email feature: specifies email type: ASATTACHMENT/ ASLINK/ ASHTML for package object, it only supports ASATTACHMENT/ ASLINK
    void
    setEncodePdf(boolean isEncodePdf)
    For PDF export: specifies whether use encoding for PDF export
    void
    setEndDate(long endDate)
    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 endTime)
    if task option is FIXEDDAYS: specifies end time for daily frequency feature
    void
    setExportTime(long exportTime)
     
    void
    setExportToMultiPages(boolean exportToMultiPages)
    DHTML/ HTML option: specifies whether export report to multi-pages
    void
    setExportToSingleWPagination(boolean isExportToSingleWPagination)
    For DHTML/ HTML export: export return in one single page with pagination specifies state of exporting report to single page with pagination
    void
    setExternalStyleSheetName(String externalStyleSheetName)
    For DHTML export: Specifies the external style sheet file used for DHTML export
    void
    setFailBodyText(String failBodyText)
    For Fail Job Email feature: specifies the body text of the email
    void
    setFailSubject(String failSubject)
    For Fail Job Email feature: specifies the subject of the email
    void
    setFailToAddress(String failToAddress)
    For Fail Job Email feature: specifies recievers' email addresses
    void
    setFromAddress(String fromAddress)
    For Email feature: specifies sender email address
    void
    setFtpDelivery(boolean ftpDelivery)
    using FTP delivery
    void
    setFtpFilePath(String ftpFilePath)
    set FTP file path
    void
    setFtpHost(String ftpHost)
    set FTP host
    void
    setFtpPassword(String ftpPassword)
    set FTP password
    void
    setFtpUserName(String ftpUserName)
    set FTP user name
    void
    setGifTransparent(boolean gifTransparent)
    using transparent background for GIF export
    void
    setImageHeight(int imageHeight)
    set exported image height
    void
    setImageWidth(int imageWidth)
    set exported image width
    void
    setIntervalType(int intervalType)
    if task option is TIME_INTERVAL: specifies export time interval: TIME/ DAYS/ MONTHS
    void
    setJpegQuality(int jpegQuality)
    set JPEG quality
    void
    setMemoryOptimized(boolean memoryOptimized)
    report export option: specifies whether using optimize memory export
    void
    setMonthInterval(int monthInterval)
    if task option is TIME_INTERVAL: specifies month interval in mins
    void
    setName(String name)
     
    void
    setNewLineDelimiter(int newLineDelimiter)
     
    void
    setPdfOwnerPassword(String pdfOwnerPassword)
    For PDF export: specifies the PDF owner password
    void
    setPdfUserPassword(String pdfUserPassword)
    For PDF export: specifies the PDF user password
    void
    setPngCompression(int pngCompression)
    set PNG compression
    void
    setPrinterDelivery(boolean printerDelivery)
    using printer delivery
    void
    setPrintFromPage(int printFromPage)
    PRINTING: set "from" page
    void
    setPrintToPage(int printToPage)
    PRINTING: set "to" page
    void
    setReportExportType(int reportExportType)
     
    void
    setSelectedPrinter(String selectedPrinter)
    set selected printer
    void
    setSendEmail(boolean sendEmail)
    For Email feature: specifies whether email notification/delivery is used for the exported report
    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 in minute for daily frequency feature
    void
    setStartDate(long startDate)
    specifies start date for scheduled event
    void
    setStartExportTime(long startExportTime)
     
    void
    setStartTime(int startTime)
    if task option is FIXEDDAYS: specifies start time for daily frequency feature
    void
    setSubject(String subject)
    For Email feature: specifies the subject of the email
    void
    setTaskOption(int taskOption)
    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 textDelimiter)
    For TXT and CSV export: specifies the text delimiter: IDelimiterConstants.TAB, IDelimiterConstanst.SPACE, IDelimiterConstant.COMMA...
    void
    setTimeInterval(int timeInterval)
    if task option is TIME_INTERVAL: specifies time interval in mins
    void
    setTimestampAttached(boolean timestampAttached)
    specifies whether timestamp is attached to export location
    void
    setUseExternalStyleSheet(boolean isUseExternalStyleSheet)
    For DHTML export: specifies whether use external style sheet for DHTML export
    void
    setUseInternalStyleSheet(boolean isUseInternalStyleSheet)
    For DHTML export: specifies whether use internal style sheet for DHTML export

    Methods inherited from class java.lang.Object

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

  • Field Details

    • PNG_COMPRESSION_DEFAULT

      public static final int PNG_COMPRESSION_DEFAULT
      One of the constants returned by the method getPNGCompression() that specifies png compression.
      See Also:

    • PNG_COMPRESSION_FAST

      public static final int PNG_COMPRESSION_FAST
      One of the constants returned by the method getPNGCompression() that specifies png compression.
      See Also:

    • PNG_COMPRESSION_MAX

      public static final int PNG_COMPRESSION_MAX
      One of the constants returned by the method getPNGCompression() that specifies png compression.
      See Also:

    • PNG_COMPRESSION_NONE

      public static final int PNG_COMPRESSION_NONE
      One of the constants returned by the method getPNGCompression() that specifies png compression.
      See Also:

    • ASATTACHMENT

      public static final int ASATTACHMENT
      One of the constants returned by the method getEmailType() that specifies an email type.
      See Also:

    • ASHTML

      public static final int ASHTML
      One of the constants returned by the method getEmailType() that specifies an email type.
      See Also:

    • NONE

      public static final int NONE
      One of the constants returned by the method getEmailType() that specifies an email type.
      See Also:

    • 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:

    • 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:

    • 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:

    • TIME

      public static final int TIME
      One of the constants returned by the method getIntervalType() that specifies export time interval.
      See Also:

    • DAYS

      public static final int DAYS
      One of the constants returned by the method getIntervalType() that specifies export time interval.
      See Also:

    • MONTHS

      public static final int MONTHS
      One of the constants returned by the method getIntervalType() that specifies export time interval.
      See Also:

  • Constructor Details

    • QbSchedulePackage

      public QbSchedulePackage(String name, QbOrganizer organizer) throws Exception
      Throws:
      Exception

    • QbSchedulePackage

      public QbSchedulePackage(quadbase.reportorganizer.data.SchedulePackage schedulePackage)

  • Method Details

    • addScheduleObject

      public void addScheduleObject(QbScheduleObject sObj)
      Parameters:
      QbScheduleObject -

    • removeScheduleObject

      public void removeScheduleObject(QbScheduleObject sObj)
      Parameters:
      QbScheduleObject -

    • getScheduleObjectById

      public QbScheduleObject getScheduleObjectById(int scheduleId)
      Parameters:
      scheduleId -
      Returns:

    • getAllScheduleObjects

      public Vector getAllScheduleObjects()
      returns Vector of all QbScheduleObjects in this package

    • getBodyText

      public String getBodyText()
      For Email feature: returns the body text of the email

    • getDayInterval

      public int getDayInterval()
      if task option is TIME_INTERVAL: returns day interval in days

    • getEmailType

      public int getEmailType()
      For Email feature: returns email type: ASATTACHMENT/ ASLINK/ ASHTML

    • getEndDate

      public long getEndDate()
      if task option is TIME_INTERVAL / FIXEDDAYS: if endDate = -1, it runs indefinitely returns end date for scheduled event

    • getEndTime

      public int getEndTime()
      returns end time for daily frequency feature

    • getExportTime

      public long getExportTime()
      Returns:
      See Also:
      • SchedulePackage.getExportTime()

    • getExternalStyleSheetName

      public String getExternalStyleSheetName()
      For DHTML export: Specifies the external style sheet file used for DHTML export returns the name of the external style sheet

    • getFailBodyText

      public String getFailBodyText()
      For Fail Job Email feature: returns the body text of the email

    • getFailSubject

      public String getFailSubject()
      For Fail Job Email feature: returns the subject of the email

    • getFailToAddress

      public String getFailToAddress()
      For Fail Job Email feature: returns receivers' email addresses

    • getFromAddress

      public String getFromAddress()
      For Email feature: returns sender email address

    • getFtpFilePath

      public String getFtpFilePath()
      returns FTP file path

    • getFtpHost

      public String getFtpHost()
      returns FTP host

    • getFtpPassword

      public String getFtpPassword()
      returns FTP password

    • getFtpUserName

      public String getFtpUserName()
      returns FTP user name

    • getChartExportType

      public int getChartExportType()
      returns exported chart type: IExportConstants.JPEG, IExportConstants.GIF, IExportConstants.PNG...
      See Also:

    • getImageHeight

      public int getImageHeight()
      returns exported image height

    • getImageWidth

      public int getImageWidth()
      returns exported image width

    • getIntervalType

      public int getIntervalType()
      if task option is TIME_INTERVAL: returns export time interval: TIME/ DAYS/ MONTHS

    • getJpegQuality

      public int getJpegQuality()
      returns JPEG file quality

    • getMonthInterval

      public int getMonthInterval()
      if task option is TIME_INTERVAL: returns month interval in months

    • getName

      public String getName()
      Returns:
      See Also:
      • SchedulePackage.getName()

    • getNewLineDelimiter

      public int getNewLineDelimiter()
      Returns:
      See Also:
      • SchedulePackage.getNewLineDelimiter()

    • getOwnerId

      public String getOwnerId()
      Returns:
      See Also:
      • SchedulePackage.getOwnerId()

    • getPdfOwnerPassword

      public String getPdfOwnerPassword()
      For PDF export: returns the PDF owner password

    • getPdfUserPassword

      public String getPdfUserPassword()
      For PDF export: returns the PDF user password

    • getPngCompression

      public int getPngCompression()
      returns PNG compression

    • getPrintFromPage

      public int getPrintFromPage()
      PRINTING: get "from" page

    • getPrintToPage

      public int getPrintToPage()
      PRINTING: get "to" page

    • getReportExportType

      public int getReportExportType()
      returns exported report type: IExportConstants.PDF, IExportConstants.DHTML, IExportConstants.HTML...
      See Also:

    • getSelectedPrinter

      public String getSelectedPrinter()
      returns selected printer

    • getSpecifyDates

      public int[] getSpecifyDates()
      if task option is FIXEDDAYS: returns export file dates

    • getSpecifyDays

      public int[] getSpecifyDays()
      if task option is FIXEDDAYS: returns export file days

    • getSpecifyTime

      public int[] getSpecifyTime()
      if task option is FIXEDDAYS: returns export file time in minute for daily frequency feature

    • getStartDate

      public long getStartDate()
      returns start date for scheduled event

    • getStartExportTime

      public long getStartExportTime()
      Returns:
      See Also:
      • SchedulePackage.getStartExportTime()

    • getStartTime

      public int getStartTime()
      returns start time for daily frequency feature

    • getSubject

      public String getSubject()
      For Email feature: returns the subject of the email

    • 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

    • getTextDelimiter

      public int getTextDelimiter()
      For TXT and CSV export: returns the text delimiter: IDelimiterConstants.TAB, IDelimiterConstanst.SPACE, IDelimiterConstant.COMMA...
      See Also:

    • getTimeInterval

      public int getTimeInterval()
      if task option is TIME_INTERVAL: returns time interval in mins

    • getUserName

      public String getUserName()
      Returns:
      See Also:
      • SchedulePackage.getUserName()

    • isArchive

      public boolean isArchive()
      returns whether it is archive job

    • isEncodePdf

      public boolean isEncodePdf()
      For PDF export: returns whether use encoding for DFT export

    • isExportToMultiPages

      public boolean isExportToMultiPages()
      DHTML/ HTML option: returns whether export report to multi-pages

    • isExportToSingleWPagination

      public boolean isExportToSingleWPagination()
      For DHTML/ HTML export: export return in one single page with pagination returns state of exporting report to single page with pagination

    • isFtpDelivery

      public boolean isFtpDelivery()
      Returns:
      See Also:
      • SchedulePackage.isFtpDelivery()

    • isGifTransparent

      public boolean isGifTransparent()
      returns whether the gif file export contains transparent background

    • isMemoryOptimized

      public boolean isMemoryOptimized()
      DHTML/ HTML option: returns whether using optimize memory export

    • isOwnerGroup

      public boolean isOwnerGroup()
      Returns:
      See Also:
      • SchedulePackage.isOwnerGroup()

    • isPrinterDelivery

      public boolean isPrinterDelivery()
      returns whether using printer delivery

    • isSendEmail

      public boolean isSendEmail()
      For Email feature: returns whether email notification/delivery is used for the exported report

    • isTimestampAttached

      public boolean isTimestampAttached()
      returns whether timestamp is attached to export location

    • isUseExternalStyleSheet

      public boolean isUseExternalStyleSheet()
      For DHTML export: returns whether use external style sheet for DHTML export

    • isUseInternalStyleSheet

      public boolean isUseInternalStyleSheet()
      For DHTML export: returns whether use internal style sheet for DHTML export

    • setArchive

      public void setArchive(boolean isArchive)
      set archive job

    • setBodyText

      public void setBodyText(String bodyText)
      For Email feature: specifies the body text of the email

    • setDayInterval

      public void setDayInterval(int dayInterval)
      if task option is TIME_INTERVAL: specifies day interval in mins

    • setEmailType

      public void setEmailType(int emailType)
      For Email feature: specifies email type: ASATTACHMENT/ ASLINK/ ASHTML for package object, it only supports ASATTACHMENT/ ASLINK

    • setEncodePdf

      public void setEncodePdf(boolean isEncodePdf)
      For PDF export: specifies whether use encoding for PDF export

    • setEndDate

      public void setEndDate(long endDate)
      if task option is TIME_INTERVAL / FIXEDDAYS: if endDate = -1, it runs indefinitely specifies end date in millis second for scheduled event

    • setEndTime

      public void setEndTime(int endTime)
      if task option is FIXEDDAYS: specifies end time for daily frequency feature

    • setExportTime

      public void setExportTime(long exportTime)
      Parameters:
      exportTime -
      See Also:
      • SchedulePackage.setExportTime(long)

    • setExportToMultiPages

      public void setExportToMultiPages(boolean exportToMultiPages)
      DHTML/ HTML option: specifies whether export report to multi-pages

    • setExportToSingleWPagination

      public void setExportToSingleWPagination(boolean isExportToSingleWPagination)
      For DHTML/ HTML export: export return in one single page with pagination specifies state of exporting report to single page with pagination

    • setExternalStyleSheetName

      public void setExternalStyleSheetName(String externalStyleSheetName)
      For DHTML export: Specifies the external style sheet file used for DHTML export
      Parameters:
      s - the name of the external style sheet

    • setFailBodyText

      public void setFailBodyText(String failBodyText)
      For Fail Job Email feature: specifies the body text of the email

    • setFailSubject

      public void setFailSubject(String failSubject)
      For Fail Job Email feature: specifies the subject of the email

    • setFailToAddress

      public void setFailToAddress(String failToAddress)
      For Fail Job Email feature: specifies recievers' email addresses

    • setFromAddress

      public void setFromAddress(String fromAddress)
      For Email feature: specifies sender email address

    • setFtpDelivery

      public void setFtpDelivery(boolean ftpDelivery)
      using FTP delivery

    • setFtpFilePath

      public void setFtpFilePath(String ftpFilePath)
      set FTP file path

    • setFtpHost

      public void setFtpHost(String ftpHost)
      set FTP host

    • setFtpPassword

      public void setFtpPassword(String ftpPassword)
      set FTP password

    • setFtpUserName

      public void setFtpUserName(String ftpUserName)
      set FTP user name

    • setGifTransparent

      public void setGifTransparent(boolean gifTransparent)
      using transparent background for GIF export

    • setChartExportType

      public void setChartExportType(int type)
      specifies exported chart type: IExportConstants.JPEG, IExportConstants.GIF, IExportConstants.PNG...
      See Also:

    • setImageHeight

      public void setImageHeight(int imageHeight)
      set exported image height

    • setImageWidth

      public void setImageWidth(int imageWidth)
      set exported image width

    • setIntervalType

      public void setIntervalType(int intervalType)
      if task option is TIME_INTERVAL: specifies export time interval: TIME/ DAYS/ MONTHS

    • setJpegQuality

      public void setJpegQuality(int jpegQuality)
      set JPEG quality

    • setMemoryOptimized

      public void setMemoryOptimized(boolean memoryOptimized)
      report export option: specifies whether using optimize memory export

    • setMonthInterval

      public void setMonthInterval(int monthInterval)
      if task option is TIME_INTERVAL: specifies month interval in mins

    • setName

      public void setName(String name)
      Parameters:
      name -
      See Also:
      • SchedulePackage.setName(java.lang.String)

    • setNewLineDelimiter

      public void setNewLineDelimiter(int newLineDelimiter)
      Parameters:
      newLineDelimiter -
      See Also:
      • SchedulePackage.setNewLineDelimiter(int)

    • setPdfOwnerPassword

      public void setPdfOwnerPassword(String pdfOwnerPassword)
      For PDF export: specifies the PDF owner password

    • setPdfUserPassword

      public void setPdfUserPassword(String pdfUserPassword)
      For PDF export: specifies the PDF user password

    • setPngCompression

      public void setPngCompression(int pngCompression)
      set PNG compression

    • setPrinterDelivery

      public void setPrinterDelivery(boolean printerDelivery)
      using printer delivery

    • setPrintFromPage

      public void setPrintFromPage(int printFromPage)
      PRINTING: set "from" page

    • setPrintToPage

      public void setPrintToPage(int printToPage)
      PRINTING: set "to" page

    • setReportExportType

      public void setReportExportType(int reportExportType)
      Parameters:
      reportExportType -
      See Also:
      • SchedulePackage.setReportExportType(int)

    • setSelectedPrinter

      public void setSelectedPrinter(String selectedPrinter)
      set selected printer

    • setSendEmail

      public void setSendEmail(boolean sendEmail)
      For Email feature: specifies whether email notification/delivery is used for the exported report

    • setSpecifyDates

      public void setSpecifyDates(int[] dates)
      if task option is FIXEDDAYS: specifies export file dates

    • setSpecifyDays

      public void setSpecifyDays(int[] days)
      if task option is FIXEDDAYS: specifies export file days

    • setSpecifyTime

      public void setSpecifyTime(int[] time)
      if task option is FIXEDDAYS: specifies export file time in minute for daily frequency feature

    • setStartDate

      public void setStartDate(long startDate)
      specifies start date for scheduled event

    • setStartExportTime

      public void setStartExportTime(long startExportTime)
      Parameters:
      startExportTime -
      See Also:
      • SchedulePackage.setStartExportTime(long)

    • setStartTime

      public void setStartTime(int startTime)
      if task option is FIXEDDAYS: specifies start time for daily frequency feature

    • setSubject

      public void setSubject(String subject)
      For Email feature: specifies the subject of the email

    • setTaskOption

      public void setTaskOption(int taskOption)
      specifies task option: ONE_TIME - export once TIME_INTERVAL - export report after certain time interval FIXEDDAYS - only export report in certain fixed days/ dates

    • setTextDelimiter

      public void setTextDelimiter(int textDelimiter)
      For TXT and CSV export: specifies the text delimiter: IDelimiterConstants.TAB, IDelimiterConstanst.SPACE, IDelimiterConstant.COMMA...
      See Also:

    • setTimeInterval

      public void setTimeInterval(int timeInterval)
      if task option is TIME_INTERVAL: specifies time interval in mins

    • setTimestampAttached

      public void setTimestampAttached(boolean timestampAttached)
      specifies whether timestamp is attached to export location

    • setUseExternalStyleSheet

      public void setUseExternalStyleSheet(boolean isUseExternalStyleSheet)
      For DHTML export: specifies whether use external style sheet for DHTML export

    • setUseInternalStyleSheet

      public void setUseInternalStyleSheet(boolean isUseInternalStyleSheet)
      For DHTML export: specifies whether use internal style sheet for DHTML export

    • deleteJob

      public boolean deleteJob()
      remove schedule job from the queue

    • getNextExportTime

      public long getNextExportTime()
      return next export time in millisecond