Package quadbase.reportorganizer.menuAPI

Class ScheduleJob

java.lang.Object
quadbase.reportorganizer.menuAPI.ScheduleJob
public class ScheduleJob extends Object

  • Constructor Details

    • ScheduleJob

      public ScheduleJob(QbMenu qbMenu, int packageID, int scheduleID) throws Exception
      retrieve ScheduleJob object from Package ID and ScheduleJob ID
      Throws:
      Exception

    • ScheduleJob

      public ScheduleJob(QbMenu qbMenu, String fullID) throws Exception
      retrieve ScheduleJob object from Full ID
      Throws:
      Exception

  • Method Details

    • getName

      public 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 String getChartLocation()
      returns chart file location

    • getReportLocation

      public String getReportLocation()
      returns report file location

    • getScheduledFileLocation

      public String getScheduledFileLocation()
      returns scheduled file location

    • getScheduledFileLocation

      public 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 String getArchiveFileLocation(int index)
      returns archive file location for the specified achive file index
      Parameters:
      index - archive file index

    • getArchiveFileLocation

      public 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 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 String getSercuityLevel() throws Exception
      Deprecated.
      Use getSecurityLevel() instead.
      returns the security level of this job
      Throws:
      Exception

    • getSecurityLevel

      public String getSecurityLevel() throws Exception
      returns the security level of this job
      Throws:
      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 String getID()
      returns full ScheduleJob ID (i.e. packageID-scheduleID)

    • isReadable

      public boolean isReadable() throws Exception
      return whether this schedule/ archive job is readable for this user
      Throws:
      Exception

    • getParamNames

      public String[] getParamNames()