Package org.netxms.client.reporting

Class ReportingJob

  • public class ReportingJob
extends Object
    Reporting job

    • Constructor Detail

      • ReportingJob

        public ReportingJob​(ReportDefinition report)
        Create reportingJob
        Parameters:
        report - report definition object

      • ReportingJob

        public ReportingJob​(org.netxms.base.NXCPMessage msg,
                    long varId)
        Create reportingJob object from NXCP message
        Parameters:
        msg -
        varId - base field id

    • Method Detail

      • setRenderFormat

        public void setRenderFormat​(ReportRenderFormat renderFormat)
        Parameters:
        renderFormat - the renderFormat to set

      • getEmailRecipients

        public List<String> getEmailRecipients()
        Returns:
        the emailRecipients

      • setEmailRecipients

        public void setEmailRecipients​(List<String> emailRecipients)
        Parameters:
        emailRecipients - the emailRecipients to set

      • getReportId

        public UUID getReportId()
        Get unique report ID
        Returns:
        unique report ID

      • getReportName

        public String getReportName()
        Returns:
        the reportName

      • getJobId

        public UUID getJobId()
        Get job ID
        Returns:
        job ID

      • getDaysOfWeek

        public int getDaysOfWeek()
        Get days of week bit mask
        Returns:
        days of week bit mask

      • setDaysOfWeek

        public void setDaysOfWeek​(int daysOfWeek)
        Set days of week bit mask
        Parameters:
        daysOfWeek - new days of week bit mask

      • getDaysOfMonth

        public int getDaysOfMonth()
        Get days of month bit mask
        Returns:
        days of month bit mask

      • setDaysOfMonth

        public void setDaysOfMonth​(int daysOfMonth)
        Set days of month bit mask
        Parameters:
        daysOfMonth - new days of month bit mask

      • getUserId

        public int getUserId()
        Get user ID
        Returns:
        user ID

      • getType

        public int getType()
        Get job type
        Returns:
        job type

      • setType

        public void setType​(int type)
        Set job type
        Parameters:
        type - new job type

      • getStartTime

        public Date getStartTime()
        Get job start time
        Returns:
        job start time

      • setStartTime

        public void setStartTime​(Date startTime)
        Set job start time
        Parameters:
        startTime - job start time

      • getComments

        public String getComments()
        Get comments
        Returns:
        comments

      • setComments

        public void setComments​(String comments)
        Set comments
        Parameters:
        comments - comments

      • isNotifyOnCompletion

        public boolean isNotifyOnCompletion()
        Check if notification on completion is on
        Returns:
        true if notification on completion is on

      • setNotifyOnCompletion

        public void setNotifyOnCompletion​(boolean notifyOnCompletion)
        Set notification on completion flag
        Parameters:
        notifyOnCompletion - new notification on completion flag