public class QbSchedulePackage
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
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
Deprecated.
Use
|
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 |
MONTHS
One of the constants returned by the method getIntervalType() that specifies export time
interval.
|
static int |
NONE
One of the constants returned by the method getEmailType() that specifies an email type.
|
static int |
ONE_TIME
One of the constants returned by the method getTaskOption() that specifies a type of task.
|
static int |
PNG_COMPRESSION_DEFAULT
One of the constants returned by the method getPNGCompression() that specifies png
compression.
|
static int |
PNG_COMPRESSION_FAST
One of the constants returned by the method getPNGCompression() that specifies png
compression.
|
static int |
PNG_COMPRESSION_MAX
One of the constants returned by the method getPNGCompression() that specifies png
compression.
|
static int |
PNG_COMPRESSION_NONE
One of the constants returned by the method getPNGCompression() that specifies png
compression.
|
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.
|
Constructor and Description |
---|
QbSchedulePackage(quadbase.reportorganizer.data.SchedulePackage schedulePackage) |
QbSchedulePackage(java.lang.String name,
QbOrganizer organizer) |
Modifier and Type | Method and Description |
---|---|
void |
addScheduleObject(QbScheduleObject sObj) |
boolean |
deleteJob()
remove schedule job from the queue
|
java.util.Vector |
getAllScheduleObjects()
returns Vector of all QbScheduleObjects in this package
|
java.lang.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() |
java.lang.String |
getExternalStyleSheetName()
For DHTML export: Specifies the external style sheet file used for DHTML export returns the
name of the external style sheet
|
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 receivers' email addresses
|
java.lang.String |
getFromAddress()
For Email feature: returns sender email address
|
java.lang.String |
getFtpFilePath()
returns FTP file path
|
java.lang.String |
getFtpHost()
returns FTP host
|
java.lang.String |
getFtpPassword()
returns FTP password
|
java.lang.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
|
java.lang.String |
getName() |
int |
getNewLineDelimiter() |
long |
getNextExportTime()
return next export time in millisecond
|
java.lang.String |
getOwnerId() |
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()
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) |
java.lang.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
|
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,
IDelimiterConstanst.SPACE, IDelimiterConstant.COMMA...
|
int |
getTimeInterval()
if task option is TIME_INTERVAL: returns time interval in mins
|
java.lang.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(java.lang.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(java.lang.String externalStyleSheetName)
For DHTML export: Specifies the external style sheet file used for DHTML export
|
void |
setFailBodyText(java.lang.String failBodyText)
For Fail Job Email feature: specifies the body text of the email
|
void |
setFailSubject(java.lang.String failSubject)
For Fail Job Email feature: specifies the subject of the email
|
void |
setFailToAddress(java.lang.String failToAddress)
For Fail Job Email feature: specifies recievers' email addresses
|
void |
setFromAddress(java.lang.String fromAddress)
For Email feature: specifies sender email address
|
void |
setFtpDelivery(boolean ftpDelivery)
using FTP delivery
|
void |
setFtpFilePath(java.lang.String ftpFilePath)
set FTP file path
|
void |
setFtpHost(java.lang.String ftpHost)
set FTP host
|
void |
setFtpPassword(java.lang.String ftpPassword)
set FTP password
|
void |
setFtpUserName(java.lang.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(java.lang.String name) |
void |
setNewLineDelimiter(int newLineDelimiter) |
void |
setPdfOwnerPassword(java.lang.String pdfOwnerPassword)
For PDF export: specifies the PDF owner password
|
void |
setPdfUserPassword(java.lang.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(java.lang.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(java.lang.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
|
public static final int PNG_COMPRESSION_DEFAULT
public static final int PNG_COMPRESSION_FAST
public static final int PNG_COMPRESSION_MAX
public static final int PNG_COMPRESSION_NONE
public static final int ASATTACHMENT
@Deprecated public static final int ASLINK
public static final int ASHTML
public static final int NONE
public static final int ONE_TIME
public static final int TIME_INTERVAL
public static final int FIXED_DAYS
public static final int TIME
public static final int DAYS
public static final int MONTHS
public QbSchedulePackage(java.lang.String name, QbOrganizer organizer) throws java.lang.Exception
java.lang.Exception
public QbSchedulePackage(quadbase.reportorganizer.data.SchedulePackage schedulePackage)
public void addScheduleObject(QbScheduleObject sObj)
QbScheduleObject
- public void removeScheduleObject(QbScheduleObject sObj)
QbScheduleObject
- public QbScheduleObject getScheduleObjectById(int scheduleId)
scheduleId
- public java.util.Vector getAllScheduleObjects()
public java.lang.String getBodyText()
public int getDayInterval()
public int getEmailType()
public long getEndDate()
public int getEndTime()
public long getExportTime()
SchedulePackage.getExportTime()
public java.lang.String getExternalStyleSheetName()
public java.lang.String getFailBodyText()
public java.lang.String getFailSubject()
public java.lang.String getFailToAddress()
public java.lang.String getFromAddress()
public java.lang.String getFtpFilePath()
public java.lang.String getFtpHost()
public java.lang.String getFtpPassword()
public java.lang.String getFtpUserName()
public int getChartExportType()
IExportConstants
public int getImageHeight()
public int getImageWidth()
public int getIntervalType()
public int getJpegQuality()
public int getMonthInterval()
public java.lang.String getName()
SchedulePackage.getName()
public int getNewLineDelimiter()
SchedulePackage.getNewLineDelimiter()
public java.lang.String getOwnerId()
SchedulePackage.getOwnerId()
public java.lang.String getPdfOwnerPassword()
public java.lang.String getPdfUserPassword()
public int getPngCompression()
public int getPrintFromPage()
public int getPrintToPage()
public int getReportExportType()
IExportConstants
public java.lang.String getSelectedPrinter()
public int[] getSpecifyDates()
public int[] getSpecifyDays()
public int[] getSpecifyTime()
public long getStartDate()
public long getStartExportTime()
SchedulePackage.getStartExportTime()
public int getStartTime()
public java.lang.String getSubject()
public int getTaskOption()
public int getTextDelimiter()
IDelimiterConstants
public int getTimeInterval()
public java.lang.String getUserName()
SchedulePackage.getUserName()
public boolean isArchive()
public boolean isEncodePdf()
public boolean isExportToMultiPages()
public boolean isExportToSingleWPagination()
public boolean isFtpDelivery()
SchedulePackage.isFtpDelivery()
public boolean isGifTransparent()
public boolean isMemoryOptimized()
public boolean isOwnerGroup()
SchedulePackage.isOwnerGroup()
public boolean isPrinterDelivery()
public boolean isSendEmail()
public boolean isTimestampAttached()
public boolean isUseExternalStyleSheet()
public boolean isUseInternalStyleSheet()
public void setArchive(boolean isArchive)
public void setBodyText(java.lang.String bodyText)
public void setDayInterval(int dayInterval)
public void setEmailType(int emailType)
public void setEncodePdf(boolean isEncodePdf)
public void setEndDate(long endDate)
public void setEndTime(int endTime)
public void setExportTime(long exportTime)
exportTime
- SchedulePackage.setExportTime(long)
public void setExportToMultiPages(boolean exportToMultiPages)
public void setExportToSingleWPagination(boolean isExportToSingleWPagination)
public void setExternalStyleSheetName(java.lang.String externalStyleSheetName)
s
- the name of the external style sheetpublic void setFailBodyText(java.lang.String failBodyText)
public void setFailSubject(java.lang.String failSubject)
public void setFailToAddress(java.lang.String failToAddress)
public void setFromAddress(java.lang.String fromAddress)
public void setFtpDelivery(boolean ftpDelivery)
public void setFtpFilePath(java.lang.String ftpFilePath)
public void setFtpHost(java.lang.String ftpHost)
public void setFtpPassword(java.lang.String ftpPassword)
public void setFtpUserName(java.lang.String ftpUserName)
public void setGifTransparent(boolean gifTransparent)
public void setChartExportType(int type)
IExportConstants
public void setImageHeight(int imageHeight)
public void setImageWidth(int imageWidth)
public void setIntervalType(int intervalType)
public void setJpegQuality(int jpegQuality)
public void setMemoryOptimized(boolean memoryOptimized)
public void setMonthInterval(int monthInterval)
public void setName(java.lang.String name)
name
- SchedulePackage.setName(java.lang.String)
public void setNewLineDelimiter(int newLineDelimiter)
newLineDelimiter
- SchedulePackage.setNewLineDelimiter(int)
public void setPdfOwnerPassword(java.lang.String pdfOwnerPassword)
public void setPdfUserPassword(java.lang.String pdfUserPassword)
public void setPngCompression(int pngCompression)
public void setPrinterDelivery(boolean printerDelivery)
public void setPrintFromPage(int printFromPage)
public void setPrintToPage(int printToPage)
public void setReportExportType(int reportExportType)
reportExportType
- SchedulePackage.setReportExportType(int)
public void setSelectedPrinter(java.lang.String selectedPrinter)
public void setSendEmail(boolean sendEmail)
public void setSpecifyDates(int[] dates)
public void setSpecifyDays(int[] days)
public void setSpecifyTime(int[] time)
public void setStartDate(long startDate)
public void setStartExportTime(long startExportTime)
startExportTime
- SchedulePackage.setStartExportTime(long)
public void setStartTime(int startTime)
public void setSubject(java.lang.String subject)
public void setTaskOption(int taskOption)
public void setTextDelimiter(int textDelimiter)
IDelimiterConstants
public void setTimeInterval(int timeInterval)
public void setTimestampAttached(boolean timestampAttached)
public void setUseExternalStyleSheet(boolean isUseExternalStyleSheet)
public void setUseInternalStyleSheet(boolean isUseInternalStyleSheet)
public boolean deleteJob()
public long getNextExportTime()