quadbase.reportorganizer.menuAPI

Class ScheduleJob

java.lang.Object

quadbase.reportorganizer.menuAPI.ScheduleJob

public class ScheduleJob
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScheduleJob(QbMenu qbMenu, int packageID, int scheduleID) retrieve ScheduleJob object from Package ID and ScheduleJob ID
ScheduleJob(QbMenu qbMenu, java.lang.String fullID) retrieve ScheduleJob object from Full ID

Method Summary

Modifier and Type	Method and Description
long	getArchiveDate(int index) returns the date of the specified achive file
java.lang.String	getArchiveFileLocation(int index) returns archive file location for the specified achive file index
java.lang.String	getArchiveFileLocation(int index, int paramIndex) returns archive file location for the specified achive file index and parameter set
int	getArchiveFilesCount() returns total number of archive files
java.lang.String	getChartLocation() returns chart file location
long	getEndDate() returns the end date of this schedule job return -1 if no end date is specified
java.lang.String	getID() returns full ScheduleJob ID (i.e.
java.lang.String	getName() returns job name
long	getNextExportTime() returns the next scheduled export time for this task
java.lang.String[]	getParamNames()
java.lang.Object[]	getParamSet(int setNumber) returns the selected value(s) for the specified parameter set
int	getParamSetCount() returns total number of parameter set
java.lang.String	getReportLocation() returns report file location
java.lang.String	getScheduledFileLocation() returns scheduled file location
java.lang.String	getScheduledFileLocation(int paramIndex) returns scheduled file location for specified parameter set
java.lang.String	getSecurityLevel() returns the security level of this job
java.lang.String	getSercuityLevel() Deprecated. Use getSecurityLevel() instead.
long	getStartDate() returns the start date of this schedule job
boolean	isArchiveJob() returns whether this is archive job
boolean	isChart() returns whether this job is for chart
boolean	isReadable() return whether this schedule/ archive job is readable for this user
boolean	isReport() returns whether this job is for report
boolean	isScheduleJob() returns whether this is schedule job

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleJob

public ScheduleJob(QbMenu qbMenu,
                   int packageID,
                   int scheduleID)
            throws java.lang.Exception

retrieve ScheduleJob object from Package ID and ScheduleJob ID

Throws:

java.lang.Exception

ScheduleJob

public ScheduleJob(QbMenu qbMenu,
                   java.lang.String fullID)
            throws java.lang.Exception

retrieve ScheduleJob object from Full ID

Throws:

java.lang.Exception

Method Detail

getName

public java.lang.String getName()

returns job name

isScheduleJob

public boolean isScheduleJob()

returns whether this is schedule job

isArchiveJob

public boolean isArchiveJob()

returns whether this is archive job

getChartLocation

public java.lang.String getChartLocation()

returns chart file location

getReportLocation

public java.lang.String getReportLocation()

returns report file location

getScheduledFileLocation

public java.lang.String getScheduledFileLocation()

returns scheduled file location

getScheduledFileLocation

public java.lang.String getScheduledFileLocation(int paramIndex)

returns scheduled file location for specified parameter set

Parameters:

paramIndex - specified parameter set index

getArchiveFilesCount

public int getArchiveFilesCount()

returns total number of archive files

getArchiveDate

public long getArchiveDate(int index)

returns the date of the specified achive file

Parameters:

index - archive file index

getArchiveFileLocation

public java.lang.String getArchiveFileLocation(int index)

returns archive file location for the specified achive file index

Parameters:

index - archive file index

getArchiveFileLocation

public java.lang.String getArchiveFileLocation(int index,
                                               int paramIndex)

returns archive file location for the specified achive file index and parameter set

Parameters:

index - archive file index

paramIndex - specified parameter set index

getParamSetCount

public int getParamSetCount()

returns total number of parameter set

getParamSet

public java.lang.Object[] getParamSet(int setNumber)

returns the selected value(s) for the specified parameter set

Parameters:

setNumber - specified parameter set index

isChart

public boolean isChart()

returns whether this job is for chart

isReport

public boolean isReport()

returns whether this job is for report

getSercuityLevel

@Deprecated
public java.lang.String getSercuityLevel()
                                               throws java.lang.Exception

Deprecated. Use getSecurityLevel() instead.

returns the security level of this job

Throws:

java.lang.Exception

getSecurityLevel

public java.lang.String getSecurityLevel()
                                  throws java.lang.Exception

returns the security level of this job

Throws:

java.lang.Exception

getNextExportTime

public long getNextExportTime()

returns the next scheduled export time for this task

getStartDate

public long getStartDate()

returns the start date of this schedule job

getEndDate

public long getEndDate()

returns the end date of this schedule job return -1 if no end date is specified

getID

public java.lang.String getID()

returns full ScheduleJob ID (i.e. packageID-scheduleID)

isReadable

public boolean isReadable()
                   throws java.lang.Exception

return whether this schedule/ archive job is readable for this user

Throws:

java.lang.Exception

getParamNames

public java.lang.String[] getParamNames()