org.imixs.workflow.jaxrs

Class ModelRestService

java.lang.Object

org.imixs.workflow.jaxrs.ModelRestService

public class ModelRestService
extends Object

The WorkflowService Handler supports methods to process different kind of request URIs

Author:

rsoika

Constructor Summary

Constructors

Constructor and Description
ModelRestService()

Method Summary

Modifier and Type	Method and Description
void	deleteModel(String version)
javax.ws.rs.core.Response	findAllEventsByTask(String version, int processid, String items, String format)
javax.ws.rs.core.Response	findAllTasks(String version, String items, String format)
javax.ws.rs.core.Response	findTasksByGroup(String version, String group, String items, String format) Returns a list of all Tasks of a specific workflow group.
javax.ws.rs.core.Response	getDefiniton(String version, String items, String format) Returns the model definition containing general model information (e.g.
List<String>	getGroups(String version, String items) Retuns a list of all Start Entities from each workflowgroup
javax.ws.rs.core.Response	getModelFile(String version, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.StreamingOutput	getModelOverview()
String	getModelXML()
javax.ws.rs.core.Response	getTask(String version, int processid, String items, String format)
javax.ws.rs.core.Response	postBPMNModel(org.imixs.workflow.bpmn.BPMNModel bpmnmodel)
javax.ws.rs.core.Response	postBPMNModel(String filename, org.imixs.workflow.bpmn.BPMNModel bpmnmodel)
void	postModel(org.imixs.workflow.xml.XMLDataCollection ecol)
void	postModelByVersion(String sModelVersion, org.imixs.workflow.xml.XMLDataCollection ecol)
javax.ws.rs.core.Response	putBPMNModel(org.imixs.workflow.bpmn.BPMNModel bpmnmodel) This method consumes a Imixs BPMN model file and updates the corresponding model information.
javax.ws.rs.core.Response	putBPMNModel(String filename, org.imixs.workflow.bpmn.BPMNModel bpmnmodel) This method consumes a Imixs BPMN model file and updates the corresponding model information.
void	putModel(org.imixs.workflow.xml.XMLDataCollection ecol) This method updates a Model provided in a EntityCollection object.
void	putModelByVersion(String _modelVersion, org.imixs.workflow.xml.XMLDataCollection ecol) This method updates a Model provided in a EntityCollection object for a provided model version.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelRestService

public ModelRestService()

Method Detail

getModelOverview

public javax.ws.rs.core.StreamingOutput getModelOverview()

getModelXML

public String getModelXML()

findAllTasks

public javax.ws.rs.core.Response findAllTasks(String version,
                                              String items,
                                              String format)

getModelFile

public javax.ws.rs.core.Response getModelFile(String version,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

getDefiniton

public javax.ws.rs.core.Response getDefiniton(String version,
                                              String items,
                                              String format)

Returns the model definition containing general model information (e.g. $ModelVersion).

getTask

public javax.ws.rs.core.Response getTask(String version,
                                         int processid,
                                         String items,
                                         String format)

findAllEventsByTask

public javax.ws.rs.core.Response findAllEventsByTask(String version,
                                                     int processid,
                                                     String items,
                                                     String format)

getGroups

public List<String> getGroups(String version,
                              String items)

Retuns a list of all Start Entities from each workflowgroup

Parameters:

version -

Returns:

findTasksByGroup

public javax.ws.rs.core.Response findTasksByGroup(String version,
                                                  String group,
                                                  String items,
                                                  String format)

Returns a list of all Tasks of a specific workflow group.

Parameters:

version -

Returns:

deleteModel

public void deleteModel(String version)

putBPMNModel

public javax.ws.rs.core.Response putBPMNModel(org.imixs.workflow.bpmn.BPMNModel bpmnmodel)

This method consumes a Imixs BPMN model file and updates the corresponding model information.

Parameters:

model -

Returns:

putBPMNModel

public javax.ws.rs.core.Response putBPMNModel(String filename,
                                              org.imixs.workflow.bpmn.BPMNModel bpmnmodel)

This method consumes a Imixs BPMN model file and updates the corresponding model information.

The filename param is used to store the file in the corresponding bpmn document.

Parameters:

model -

Returns:

postBPMNModel

public javax.ws.rs.core.Response postBPMNModel(org.imixs.workflow.bpmn.BPMNModel bpmnmodel)

postBPMNModel

public javax.ws.rs.core.Response postBPMNModel(String filename,
                                               org.imixs.workflow.bpmn.BPMNModel bpmnmodel)

putModelByVersion

public void putModelByVersion(String _modelVersion,
                              org.imixs.workflow.xml.XMLDataCollection ecol)

This method updates a Model provided in a EntityCollection object for a provided model version. The Method expects a subresource with a ModelVersion. Next the method updates each Entity object with the property $ModelVersion. An old version will be automatically removed before update.

Parameters:

version - - $modelversion

ecol - - model data

postModelByVersion

public void postModelByVersion(String sModelVersion,
                               org.imixs.workflow.xml.XMLDataCollection ecol)

putModel

public void putModel(org.imixs.workflow.xml.XMLDataCollection ecol)

This method updates a Model provided in a EntityCollection object. The method takes the first entity to get the provided $modelVersion. An old version will be automatically removed before update.

Parameters:

ecol -

postModel

public void postModel(org.imixs.workflow.xml.XMLDataCollection ecol)