Package org.netxms.client.reporting
Class ReportResult
java.lang.Object
org.netxms.client.reporting.ReportResult
Report execution result
-
Constructor Summary
ModifierConstructorDescriptionprotected
Default constructor - only intended for use during XML deserializationReportResult
(UUID jobId, UUID reportId, Date executionTime, int userId, boolean success) Create new report result object.ReportResult
(NXCPMessage msg, long baseId) Create report result object from NXCP message. -
Method Summary
Modifier and TypeMethodDescriptionCreate XML from object.void
fillMessage
(NXCPMessage msg, long baseId) Fill NXCP message with object's data.Get execution time.getJobId()
Get job ID.Get report ID.int
Get user ID.boolean
Get success indicator.static ReportResult
loadFromFile
(File xmlFile) Create report result object from XML filevoid
Save object as XML file.toString()
-
Constructor Details
-
ReportResult
protected ReportResult()Default constructor - only intended for use during XML deserialization -
ReportResult
Create new report result object.- Parameters:
jobId
- reporting job IDreportId
- report IDexecutionTime
- execution timeuserId
- user (initiator) IDsuccess
- success indicator
-
ReportResult
Create report result object from NXCP message.- Parameters:
msg
- NXCP messagebaseId
- base field ID
-
-
Method Details
-
loadFromFile
Create report result object from XML file- Parameters:
xmlFile
- file containing XML document- Returns:
- reporting job parameters object
- Throws:
Exception
- if de-serialization is not possible
-
fillMessage
Fill NXCP message with object's data.- Parameters:
msg
- NXCP messagebaseId
- base field ID
-
createXml
Create XML from object.- Returns:
- XML document
- Throws:
Exception
- if the schema for the object is not valid
-
saveAsXml
Save object as XML file.- Parameters:
file
- destination file- Throws:
Exception
- if the schema for the object is not valid or write operation failed
-
getJobId
Get job ID.- Returns:
- job ID
-
getReportId
Get report ID.- Returns:
- report ID
-
getExecutionTime
Get execution time.- Returns:
- execution time
-
getUserId
public int getUserId()Get user ID.- Returns:
- user ID
-
isSuccess
public boolean isSuccess()Get success indicator.- Returns:
- true if execution was successful
-
toString
-