Package org.netxms.client.reporting
Class ReportingJob
java.lang.Object
org.netxms.client.reporting.ReportingJob
Reporting job
-
Constructor Summary
ConstructorDescriptionReportingJob
(NXCPMessage msg, long baseId) Create reporting job object from NXCP messageReportingJob
(ReportDefinition report) Create reporting job -
Method Summary
Modifier and TypeMethodDescriptionvoid
fillMessage
(NXCPMessage msg) Fill NXCP message with job data.getExecutionParameter
(String name) Get value of single reporting job execution parameter.Get all reporting job execution parameters.Get unique report IDgetTask()
Get underlying scheduled taskboolean
Check if notification on completion is onPrepare underlying scheduled task for create or update API call.void
setEmailRecipients
(List<String> emailRecipients) void
setExecutionParameter
(String name, String value) Set reporting job execution parameter.void
setNotifyOnCompletion
(boolean notifyOnCompletion) Set notification on completion flagvoid
setRenderFormat
(ReportRenderFormat renderFormat)
-
Constructor Details
-
ReportingJob
Create reporting job- Parameters:
report
- report definition object
-
ReportingJob
Create reporting job object from NXCP message- Parameters:
msg
- NXCP messagebaseId
- base field id
-
-
Method Details
-
fillMessage
Fill NXCP message with job data. Will serialize execution parameters and update underlying scheduled task.- Parameters:
msg
- NXCP message- Throws:
NXCException
- if execution parameters serialization fails
-
getRenderFormat
- Returns:
- the renderFormat
-
setRenderFormat
- Parameters:
renderFormat
- the renderFormat to set
-
getEmailRecipients
- Returns:
- the emailRecipients
-
setEmailRecipients
- Parameters:
emailRecipients
- the emailRecipients to set
-
getReportId
Get unique report ID- Returns:
- unique report ID
-
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
-
getExecutionParameters
Get all reporting job execution parameters. Any changes to returned map will be reflected in job object.- Returns:
- all reporting job execution parameters
-
getExecutionParameter
Get value of single reporting job execution parameter.- Parameters:
name
- parameter name- Returns:
- parameter value or null
-
setExecutionParameter
Set reporting job execution parameter.- Parameters:
name
- parameter namevalue
- parameter value
-
prepareTask
Prepare underlying scheduled task for create or update API call.- Returns:
- underlying scheduled task
- Throws:
Exception
- if task parameter serialization fails
-
getTask
Get underlying scheduled task- Returns:
- underlying scheduled task
-