org.imixs.workflow.webservices.soap
Class WorkflowReportClient

java.lang.Object
  org.imixs.workflow.webservices.soap.WorkflowReportClient

All Implemented Interfaces:

WorkflowReportService

public class WorkflowReportClient
extends Object
implements WorkflowReportService

The WorkflowManagerClient is a WebSerice Client for the Imixs WorkflowManager Service based on the Apache Axiom Framework. The WorkflowManagerClient uses the helper class org.imixs.workflow.service.client.axiom.ServiceClient to establish SOAP Connections

Author:

Ralph Soika

See Also:

org.imixs.workflow.RestClient.client.axiom.ServiceClient

Constructor Summary

WorkflowReportClient(String aServiceEndpoint, String aUserName, String aPassword)

Method Summary

String	getNameSpace()
XMLItemCollection	getReport(String name) returns a QueryEntity Object identified by the attribute txtname
EntityCollection	getReportList(int start, int count) This method returns a collection of reports (Maps).
ServiceClient	getServiceClient()
EntityCollection	processQuery(String reportid) 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	setNameSpace(String s)
void	updateReport(XMLItemCollection report) updates a Entity Report Object.
void	updateReportList(EntityCollection reportList) updates a list of Entity Report Objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowReportClient

public WorkflowReportClient(String aServiceEndpoint,
                            String aUserName,
                            String aPassword)

Method Detail

getNameSpace

public String getNameSpace()

setNameSpace

public void setNameSpace(String s)

getServiceClient

public ServiceClient getServiceClient()

getReport

public XMLItemCollection getReport(String name)
                            throws Exception

Description copied from interface: WorkflowReportService

returns a QueryEntity Object identified by the attribute txtname

Specified by:

getReport in interface WorkflowReportService

Returns:

entity object representing the Report

Throws:

Exception

getReportList

public EntityCollection getReportList(int start,
                                      int count)
                               throws Exception

Description copied from interface: WorkflowReportService

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.

Specified by:

getReportList in interface WorkflowReportService

Throws:

Exception

processQuery

public EntityCollection processQuery(String reportid)
                              throws Exception

Description copied from interface: WorkflowReportService

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

Specified by:

processQuery in interface WorkflowReportService

Returns:

Throws:

Exception

updateReport

public void updateReport(XMLItemCollection report)
                  throws Exception

Description copied from interface: WorkflowReportService

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.

Specified by:

updateReport in interface WorkflowReportService

Throws:

Exception

updateReportList

public void updateReportList(EntityCollection reportList)
                      throws Exception

Description copied from interface: WorkflowReportService

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.

Specified by:

updateReportList in interface WorkflowReportService

Throws:

Exception