org.imixs.workflow.jee.ejb
Interface ReportService

All Known Subinterfaces:

ReportServiceRemote

public interface ReportService

The ReportManager interface supports methods to create, process and find report instances. This interface is implemented by the ReportServiceBean. 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:

Ralph Soika

Method Summary

org.imixs.workflow.ItemCollection	getReport(java.lang.String aReportName) Returns a Report Entity identified by the attribute txtname
java.util.Collection<org.imixs.workflow.ItemCollection>	getReportList(int startpos, int count) Returns a collection of reports (ItemCollection).
java.util.Collection<org.imixs.workflow.ItemCollection>	processReport(java.lang.String aReportName) Process a QueryEntity Object identified by the attribute txtname.
void	updateReport(org.imixs.workflow.ItemCollection aReport) updates a Entity Report Object.

Method Detail

getReport

org.imixs.workflow.ItemCollection getReport(java.lang.String aReportName)
                                            throws java.lang.Exception

Returns a Report Entity identified by the attribute txtname

Parameters:

aReportName - - name of the report

Returns:

ItemCollection representing the Report

Throws:

java.lang.Exception

getReportList

java.util.Collection<org.imixs.workflow.ItemCollection> getReportList(int startpos,
                                                                      int count)
                                                                      throws java.lang.Exception

Returns a collection of reports (ItemCollection). The method should return a subset of a collection if the start and count parameters differ form the value -1. The method returns only ItemCollections the call has sufficient read access for.

Throws:

java.lang.Exception

updateReport

void updateReport(org.imixs.workflow.ItemCollection aReport)
                  throws java.lang.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:

java.lang.Exception

processReport

java.util.Collection<org.imixs.workflow.ItemCollection> processReport(java.lang.String aReportName)
                                                                      throws java.lang.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:

java.lang.Exception