org.netxms.client.reporting

Class ReportingJob

java.lang.Object

org.netxms.client.reporting.ReportingJob

public class ReportingJob
extends Object

Reporting job

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_DAILY
static int	TYPE_MONTHLY
static int	TYPE_ONCE
static int	TYPE_WEEKLY

Constructor Summary

Constructors

Constructor and Description
ReportingJob(NXCPMessage msg, long varId) Create reportingJob object from NXCP message
ReportingJob(ReportDefinition report) Create reportingJob

Method Summary

Modifier and Type	Method and Description
String	getComments() Get comments
int	getDaysOfMonth() Get days of month bit mask
int	getDaysOfWeek() Get days of week bit mask
List<String>	getEmailRecipients()
UUID	getJobId() Get job ID
ReportRenderFormat	getRenderFormat()
UUID	getReportId() Get unique report ID
String	getReportName()
Date	getStartTime() Get job start time
int	getType() Get job type
int	getUserId() Get user ID
boolean	isNotifyOnCompletion() Check if notification on completion is on
void	setComments(String comments) Set comments
void	setDaysOfMonth(int daysOfMonth) Set days of month bit mask
void	setDaysOfWeek(int daysOfWeek) Set days of week bit mask
void	setEmailRecipients(List<String> emailRecipients)
void	setNotifyOnCompletion(boolean notifyOnCompletion) Set notification on completion flag
void	setRenderFormat(ReportRenderFormat renderFormat)
void	setStartTime(Date startTime) Set job start time
void	setType(int type) Set job type
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_ONCE

public static final int TYPE_ONCE

See Also:

Constant Field Values

TYPE_DAILY

public static final int TYPE_DAILY

See Also:

Constant Field Values

TYPE_WEEKLY

public static final int TYPE_WEEKLY

See Also:

Constant Field Values

TYPE_MONTHLY

public static final int TYPE_MONTHLY

See Also:

Constant Field Values

Constructor Detail

ReportingJob

public ReportingJob(ReportDefinition report)

Create reportingJob

Parameters:

report - report definition object

ReportingJob

public ReportingJob(NXCPMessage msg,
                    long varId)

Create reportingJob object from NXCP message

Parameters:

msg -

varId - base field id

Method Detail

getRenderFormat

public ReportRenderFormat getRenderFormat()

Returns:

the renderFormat

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

toString

public String toString()

Overrides:

toString in class Object