@Path(value="/report")
@Produces(value={"application/xml","application/json","text/html","text/xml"})
public class ReportRestService
extends Object
| Constructor and Description |
|---|
ReportRestService() |
| 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 |
getCustomResult(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 Datatable corresponding to the report definition and report content
type.
|
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() |
org.imixs.workflow.xml.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.
|
org.imixs.workflow.xml.XMLDataCollection |
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
|
org.imixs.workflow.xml.XMLDataCollection |
getReportDefinition(String name)
Returns a single report by name or by uniqueid
|
org.imixs.workflow.xml.XMLDataCollection |
getReportsDefinitions() |
org.imixs.workflow.xml.XMLDataCollection |
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(org.imixs.workflow.xml.XMLDocument reportCol) |
void |
putReport(org.imixs.workflow.xml.XMLDocument reportCol)
This method updates or creates a Report object provided in a
XMLItemCollection object
|
@GET @Produces(value="text/html") public javax.ws.rs.core.StreamingOutput getHelpHTML()
@GET @Path(value="/definitions") public org.imixs.workflow.xml.XMLDataCollection getReportsDefinitions()
@GET
@Path(value="/definitions/{name}")
public org.imixs.workflow.xml.XMLDataCollection getReportDefinition(@PathParam(value="name")
String name)
name - reportname or uniqueid of report@GET
@Path(value="/{name}.imixs-report")
public javax.ws.rs.core.Response getExcecuteReport(@PathParam(value="name")
String reportName,
@DefaultValue(value="1000") @QueryParam(value="pageSize")
int pageSize,
@DefaultValue(value="0") @QueryParam(value="pageIndex")
int pageIndex,
@QueryParam(value="sortBy")
String sortBy,
@QueryParam(value="sortReverse")
boolean sortReverse,
@DefaultValue(value="") @QueryParam(value="encoding")
String encoding,
@Context
javax.ws.rs.core.UriInfo uriInfo)
name - reportname of the report to be executed@GET
@Path(value="/{name}.pdf")
public javax.ws.rs.core.Response getPdfReport(@PathParam(value="name")
String reportName,
@DefaultValue(value="1000") @QueryParam(value="pageSize")
int pageSize,
@DefaultValue(value="0") @QueryParam(value="pageIndex")
int pageIndex,
@QueryParam(value="sortBy")
String sortBy,
@QueryParam(value="sortReverse")
boolean sortReverse,
@DefaultValue(value="") @QueryParam(value="encoding")
String encoding,
@Context
javax.ws.rs.core.UriInfo uriInfo)
name - reportname of the report to be executed@GET
@Produces(value={"text/html","application/xhtml+xml"})
@Path(value="/{name}.html")
public org.imixs.workflow.xml.DocumentTable getHTMLResult(@PathParam(value="name")
String reportName,
@DefaultValue(value="1000") @QueryParam(value="pageSize")
int pageSize,
@DefaultValue(value="0") @QueryParam(value="pageIndex")
int pageIndex,
@QueryParam(value="sortBy")
String sortBy,
@QueryParam(value="sortReverse")
boolean sortReverse,
@DefaultValue(value="") @QueryParam(value="encoding")
String encoding,
@Context
javax.ws.rs.core.UriInfo uriInfo,
@Context
javax.servlet.http.HttpServletResponse servlerResponse)
name - start - count - @GET
@Path(value="/custom/{name}.{s:.*}")
public javax.ws.rs.core.Response getCustomResult(@PathParam(value="name")
String reportName,
@DefaultValue(value="1000") @QueryParam(value="pageSize")
int pageSize,
@DefaultValue(value="0") @QueryParam(value="pageIndex")
int pageIndex,
@QueryParam(value="sortBy")
String sortBy,
@QueryParam(value="sortReverse")
boolean sortReverse,
@DefaultValue(value="") @QueryParam(value="encoding")
String encoding,
@Context
javax.ws.rs.core.UriInfo uriInfo,
@Context
javax.servlet.http.HttpServletResponse servlerResponse)
The path annotation allows any file extension.
name - start - count - @GET
@Produces(value={"application/xml","text/xml"})
@Path(value="/{name}.xml")
public org.imixs.workflow.xml.XMLDataCollection getXMLResult(@PathParam(value="name")
String reportName,
@DefaultValue(value="100") @QueryParam(value="pageSize")
int pageSize,
@DefaultValue(value="0") @QueryParam(value="pageIndex")
int pageIndex,
@QueryParam(value="sortBy")
String sortBy,
@QueryParam(value="sortReverse")
boolean sortReverse,
@DefaultValue(value="") @QueryParam(value="encoding")
String encoding,
@Context
javax.ws.rs.core.UriInfo uriInfo,
@Context
javax.servlet.http.HttpServletResponse servlerResponse)
throws Exception
name - reportname of the report to be executedstart - count - Exception@GET
@Produces(value="application/json")
@Path(value="/{name}.json")
public org.imixs.workflow.xml.XMLDataCollection getJSONResult(@PathParam(value="name")
String name,
@DefaultValue(value="-1") @QueryParam(value="pageSize")
int pageSize,
@DefaultValue(value="0") @QueryParam(value="pageIndex")
int pageIndex,
@QueryParam(value="sortBy")
String sortBy,
@QueryParam(value="sortReverse")
boolean sortReverse,
@DefaultValue(value="") @QueryParam(value="encoding")
String encoding,
@Context
javax.ws.rs.core.UriInfo uriInfo,
@Context
javax.servlet.http.HttpServletResponse servlerResponse)
throws Exception
name - reportname of the report to be executedstart - count - Exception@DELETE
@Path(value="/reports/{name}")
public void deleteReport(@PathParam(value="name")
String name)
name - of report or uniqueid@PUT
@Consumes(value={"application/xml","application/octet-stream","text/plain","text/xml"})
public void putReport(org.imixs.workflow.xml.XMLDocument reportCol)
reportCol - - report data@POST
@Consumes(value={"application/xml","application/octet-stream","text/plain","text/xml"})
public void postReport(org.imixs.workflow.xml.XMLDocument reportCol)
Copyright © 2006–2019 Imixs Software Solutions GmbH. All rights reserved.