jet.server.api
Interface OndemandReportRecord

All Superinterfaces:

java.io.Serializable

public interface OndemandReportRecord

extends java.io.Serializable

Interface OndemandReportRecord contains information of a ondemand report in the report server.

Method Summary

java.lang.String	getCatalog() Return the catalog.
int	getCatalogVersionNumber() Get catalog version number, it indicate which version of the catalog is used.
long	getCompletedTime() Return the completed time if the report runs over, else return -1.
java.lang.String	getErrorMessage() Return Error Message if the ondemand Report Running wrongly.
java.lang.String	getOndemandID() Get the ondemand report record id.
java.util.Properties	getParameters() Return the parameter properties.
java.lang.String	getQuery() Return the HTTP query for "To Applet".
java.lang.String	getReportName() Return the report name.
int	getReportVersionNumber() Get report version number, it indicate which version of the report is used.
java.lang.String	getResult() Return the report result.
java.lang.String	getResultPath() Get path that represent a result doc, if this ondemand report record represent a result doc.
int	getResultVersionNumber() Get the result doc version number that this ondemand report record represents.
long	getStartedTime() Return the started time of the report running.
long	getTimeElapse() Return time elapse in milliseconds if the report does not runs over, else return the running time.
java.lang.String	getUserID() Return the user ID.
boolean	isCompleted() Return if the report runs over.
boolean	isTempResult() Check if this ondemand report record represent a temp result or result doc.

Method Detail

getUserID

public java.lang.String getUserID()

Return the user ID.

Returns:

the user ID.

getResult

public java.lang.String getResult()

Return the report result.

Returns:

the report result.

getCatalog

public java.lang.String getCatalog()

Return the catalog.

Returns:

the catalog.

getReportName

public java.lang.String getReportName()

Return the report name.

Returns:

the report name.

getParameters

public java.util.Properties getParameters()

Return the parameter properties.

Returns:

the parameter properties.

getQuery

public java.lang.String getQuery()

Return the HTTP query for "To Applet".

Returns:

the HTTP query for "To Applet".

getStartedTime

public long getStartedTime()

Return the started time of the report running. the number of milliseconds since January 1, 1970, 00:00:00 GMT.

Returns:

the started time of the report running. the number of milliseconds since January 1, 1970, 00:00:00 GMT.

isCompleted

public boolean isCompleted()

Return if the report runs over.

Returns:

if the report runs over.

getCompletedTime

public long getCompletedTime()

Return the completed time if the report runs over, else return -1. the number of milliseconds since January 1, 1970, 00:00:00 GMT.

Returns:

the completed time if the report runs over, else return -1. the number of milliseconds since January 1, 1970, 00:00:00 GMT.

getTimeElapse

public long getTimeElapse()

Return time elapse in milliseconds if the report does not runs over, else return the running time.

Returns:

time elapse in milliseconds if the report does not runs over, else return the running time.

getErrorMessage

public java.lang.String getErrorMessage()

Return Error Message if the ondemand Report Running wrongly.

Returns:

Error Message if the ondemand Report Running wrongly

getCatalogVersionNumber

public int getCatalogVersionNumber()

Get catalog version number, it indicate which version of the catalog is used.

Returns:

the catalog version number

getReportVersionNumber

public int getReportVersionNumber()

Get report version number, it indicate which version of the report is used.

Returns:

the report version number

getOndemandID

public java.lang.String getOndemandID()

Get the ondemand report record id.

Returns:

the ondemand report record id.

isTempResult

public boolean isTempResult()

Check if this ondemand report record represent a temp result or result doc.

Returns:

true if this ondemand report record represent a temp result

getResultPath

public java.lang.String getResultPath()

Get path that represent a result doc, if this ondemand report record represent a result doc.

Returns:

path that present result doc corresponding to this ondemand report record, or null if this ondemand report record represent a temp result

getResultVersionNumber

public int getResultVersionNumber()

Get the result doc version number that this ondemand report record represents.

Returns:

the result doc version number