Package org.netxms.client.reporting

Class ReportResult

java.lang.Object

org.netxms.client.reporting.ReportResult

public class ReportResult
extends Object

Report execution result

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReportResult()	Default constructor - only intended for use during XML deserialization
	ReportResult(UUID jobId, UUID reportId, boolean carboneReport, 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 Type	Method	Description
String	createXml()	Create XML from object.
void	fillMessage(NXCPMessage msg, long baseId)	Fill NXCP message with object's data.
Date	getExecutionTime()	Get execution time.
UUID	getJobId()	Get job ID.
UUID	getReportId()	Get report ID.
int	getUserId()	Get user ID.
boolean	isCarboneReport()	Returns true if this report definition is intended for Carbone renderer instead of standard Jasper renderer.
boolean	isSuccess()	Get success indicator.
static ReportResult	loadFromFile(File xmlFile)	Create report result object from XML file
void	saveAsXml(File file)	Save object as XML file.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ReportResult

protected ReportResult()

Default constructor - only intended for use during XML deserialization

ReportResult

public ReportResult(UUID jobId,
 UUID reportId,
 boolean carboneReport,
 Date executionTime,
 int userId,
 boolean success)

Create new report result object.

Parameters:

jobId - reporting job ID

reportId - report ID

carboneReport - true if report should be rendered with Carbone

executionTime - execution time

userId - user (initiator) ID

success - success indicator

ReportResult

public ReportResult(NXCPMessage msg,
 long baseId)

Create report result object from NXCP message.

Parameters:

msg - NXCP message

baseId - base field ID

Method Details

loadFromFile

public static ReportResult loadFromFile(File xmlFile)
                                 throws Exception

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

public void fillMessage(NXCPMessage msg,
 long baseId)

Fill NXCP message with object's data.

Parameters:

msg - NXCP message

baseId - base field ID

createXml

public String createXml()
                 throws Exception

Create XML from object.

Returns:

XML document

Throws:

Exception - if the schema for the object is not valid

saveAsXml

public void saveAsXml(File file)
               throws Exception

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

public UUID getJobId()

Get job ID.

Returns:

job ID

getReportId

public UUID getReportId()

Get report ID.

Returns:

report ID

getExecutionTime

public Date 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

isCarboneReport

public boolean isCarboneReport()

Returns true if this report definition is intended for Carbone renderer instead of standard Jasper renderer.

Returns:

true if this report definition is intended for Carbone renderer

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()