org.imixs.workflow.jaxrs.v40

Class ReportRestServiceV40

java.lang.Object

org.imixs.workflow.jaxrs.v40.ReportRestServiceV40

public class ReportRestServiceV40
extends Object

The WorkflowService Handler supports methods to process different kind of request URIs

Author:

rsoika

Constructor Summary

Constructors

Constructor and Description
ReportRestServiceV40()

Method Summary

Modifier and Type	Method and Description
void	deleteReport(String name) Deletes a report by name or by its $uniqueID or name.
static void	fopTranformation(String xmlSource, String xslSource, String aEncoding, OutputStream output) This method dos a apache FOP transformation using the FopFactory
javax.ws.rs.core.Response	getExcecuteReport(String reportName, int pageSize, int pageIndex, String sortBy, boolean sortReverse, String encoding, javax.ws.rs.core.UriInfo uriInfo) Executes a single report defined by name or uniqueid The output depends on the requested media format Since 2.1.2: the ReportService also supports FOP Transformation.
javax.ws.rs.core.StreamingOutput	getHelpHTML()
DocumentTable	getHTMLResult(String reportName, int pageSize, int pageIndex, String sortBy, boolean sortReverse, String encoding, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletResponse servlerResponse) Returns an HTML Stream with a HTML Datatable corresponding to the report query.
DocumentCollection	getJSONResult(String name, int pageSize, int pageIndex, String sortBy, boolean sortReverse, String encoding, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletResponse servlerResponse) Returns a JSON stream from a report If a attribute list is defined in the report only the corresponding properties will be returend in the xml stream.
javax.ws.rs.core.Response	getPdfReport(String reportName, int pageSize, int pageIndex, String sortBy, boolean sortReverse, String encoding, javax.ws.rs.core.UriInfo uriInfo) helper method for .pdf file extention
XMLItemCollection	getReportDefinition(String name) Returns a single report by name or by uniqueid
DocumentCollection	getReportsDefinitions()
DocumentCollection	getXMLResult(String reportName, int pageSize, int pageIndex, String sortBy, boolean sortReverse, String encoding, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletResponse servlerResponse) Returns a xml stream from a report If a attribute list is defined in the report only the corresponding properties will be returend in the xml stream.
void	postReport(XMLItemCollection reportCol)
void	putReport(XMLItemCollection reportCol) This method updates or creates a Report object provided in a XMLItemCollection object

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportRestServiceV40

public ReportRestServiceV40()

Method Detail

getHelpHTML

public javax.ws.rs.core.StreamingOutput getHelpHTML()

getReportsDefinitions

public DocumentCollection getReportsDefinitions()

getReportDefinition

public XMLItemCollection getReportDefinition(String name)

Returns a single report by name or by uniqueid

Parameters:

name - reportname or uniqueid of report

Returns:

getExcecuteReport

public javax.ws.rs.core.Response getExcecuteReport(String reportName,
                                                   int pageSize,
                                                   int pageIndex,
                                                   String sortBy,
                                                   boolean sortReverse,
                                                   String encoding,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo uriInfo)

Executes a single report defined by name or uniqueid The output depends on the requested media format Since 2.1.2: the ReportService also supports FOP Transformation. If the ContentType is 'application/pdf' the method will call fopTransofrmation instat of xslTransformation. The FOP API need to be provided by the main application.

Parameters:

name - reportname of the report to be executed

Returns:

a collection of entiteis

getPdfReport

public javax.ws.rs.core.Response getPdfReport(String reportName,
                                              int pageSize,
                                              int pageIndex,
                                              String sortBy,
                                              boolean sortReverse,
                                              String encoding,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

helper method for .pdf file extention

Parameters:

name - reportname of the report to be executed

Returns:

a collection of entiteis

getHTMLResult

public DocumentTable getHTMLResult(String reportName,
                                   int pageSize,
                                   int pageIndex,
                                   String sortBy,
                                   boolean sortReverse,
                                   String encoding,
                                   @Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   javax.servlet.http.HttpServletResponse servlerResponse)

Returns an HTML Stream with a HTML Datatable corresponding to the report query.

Parameters:

name -

start -

count -

Returns:

getXMLResult

public DocumentCollection getXMLResult(String reportName,
                                       int pageSize,
                                       int pageIndex,
                                       String sortBy,
                                       boolean sortReverse,
                                       String encoding,
                                       @Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @Context
                                       javax.servlet.http.HttpServletResponse servlerResponse)
                                throws Exception

Returns a xml stream from a report If a attribute list is defined in the report only the corresponding properties will be returend in the xml stream. If the query param 'items' is provided the attribute list in the report will be ignored.

Parameters:

name - reportname of the report to be executed

start -

count -

Returns:

Throws:

Exception

getJSONResult

public DocumentCollection getJSONResult(String name,
                                        int pageSize,
                                        int pageIndex,
                                        String sortBy,
                                        boolean sortReverse,
                                        String encoding,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.servlet.http.HttpServletResponse servlerResponse)
                                 throws Exception

Returns a JSON stream from a report If a attribute list is defined in the report only the corresponding properties will be returend in the xml stream.

Parameters:

name - reportname of the report to be executed

start -

count -

Returns:

Throws:

Exception

deleteReport

public void deleteReport(String name)

Deletes a report by name or by its $uniqueID or name.

Parameters:

name - of report or uniqueid

putReport

public void putReport(XMLItemCollection reportCol)

This method updates or creates a Report object provided in a XMLItemCollection object

Parameters:

reportCol - - report data

postReport

public void postReport(XMLItemCollection reportCol)

fopTranformation

public static void fopTranformation(String xmlSource,
                                    String xslSource,
                                    String aEncoding,
                                    OutputStream output)
                             throws Exception

This method dos a apache FOP transformation using the FopFactory

Parameters:

xmlSource -

xslSource -

aEncoding -

outputWriter -

Throws:

Exception