org.imixs.workflow.webservices.soap
Interface WorkflowReportService

All Known Implementing Classes:

WorkflowReportClient

public interface WorkflowReportService

Service Interface of a ReportService. This Service Interface supports methods to create, process and find report instances. This interface should be used by a workflowReportService server component. A Report Entity is identified by its name represented by the attribute 'txtname' So a ReportService Implementation should ensure that txtname is a unique key for the report entity. Also each report entity holds a EQL Query in the attribute "txtquery". this eql statement will be processed by the processQuery method and should return a collection of entities defined by the query.

Author:

rsoika

Method Summary

XMLItemCollection	getReport(String name) returns a QueryEntity Object identified by the attribute txtname
EntityCollection	getReportList(int startpos, int count) This method returns a collection of reports (Maps).
EntityCollection	processQuery(String name) Process a QueryEntity Object identified by the attribute txtname All informations about the Query are stored in the QueryObject these attributes are: txtQuery, numMaxCount, numStartPost, txtName
void	updateReport(XMLItemCollection report) updates a Entity Report Object.
void	updateReportList(EntityCollection reportList) updates a list of Entity Report Objects.

Method Detail

updateReport

void updateReport(XMLItemCollection report)
                  throws Exception

updates a Entity Report Object. The Entity representing a report must have at least the attributes : txtQuery, numMaxCount, numStartPost, txtName. txtName is the unique key to be use to get a query.

Parameters:

report -

Throws:

Exception

updateReportList

void updateReportList(EntityCollection reportList)
                      throws Exception

updates a list of Entity Report Objects. Each Entity representing a report must have at least the attributes : txtQuery, numMaxCount, numStartPost, txtName. txtName is the unique key to be use to get a query.

Parameters:

reportList -

Throws:

Exception

getReport

XMLItemCollection getReport(String name)
                            throws Exception

returns a QueryEntity Object identified by the attribute txtname

Parameters:

aID -

Returns:

entity object representing the Report

Throws:

Exception

getReportList

EntityCollection getReportList(int startpos,
                               int count)
                               throws Exception

This method returns a collection of reports (Maps). The web service should return a subset of a collection if the start and count parameters differ form the value -1. The web service has to care that the CallerPrincipal has read access rights for each report to be returned. The method returns only workitems the call has sufficient read access for.

Throws:

Exception

processQuery

EntityCollection processQuery(String name)
                              throws Exception

Process a QueryEntity Object identified by the attribute txtname All informations about the Query are stored in the QueryObject these attributes are: txtQuery, numMaxCount, numStartPost, txtName

Parameters:

aID -

Returns:

Throws:

Exception