org.imixs.workflow.jee.ejb
Class ReportService

java.lang.Object
  org.imixs.workflow.jee.ejb.ReportService

@DeclareRoles(value={"org.imixs.ACCESSLEVEL.NOACCESS","org.imixs.ACCESSLEVEL.READERACCESS","org.imixs.ACCESSLEVEL.AUTHORACCESS","org.imixs.ACCESSLEVEL.EDITORACCESS","org.imixs.ACCESSLEVEL.MANAGERACCESS"})
@RolesAllowed(value={"org.imixs.ACCESSLEVEL.NOACCESS","org.imixs.ACCESSLEVEL.READERACCESS","org.imixs.ACCESSLEVEL.AUTHORACCESS","org.imixs.ACCESSLEVEL.EDITORACCESS","org.imixs.ACCESSLEVEL.MANAGERACCESS"})
public class ReportService
extends Object

The ReportService supports methods to create, process and find report instances. 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

Constructor Summary

ReportService()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportService

public ReportService()

Method Detail

getReport

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

Returns a Report Entity identified by the attribute txtname

Parameters:

aReportName - - name of the report

Returns:

ItemCollection representing the Report

Throws:

Exception

getReportList

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

This method 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:

Exception

updateReport

public void updateReport(org.imixs.workflow.ItemCollection aReport)
                  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. The method checks if a report with the same key allready exists. If so this report will be updated. If no report exists the new report will be created

Parameters:

report -

Throws:

Exception

processReport

public Collection<org.imixs.workflow.ItemCollection> processReport(String aReportName)
                                                            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