A B C D E F G I M O P R W X

A

AdminPRestService - Class in org.imixs.workflow.jaxrs

The AdminPRestService provides methods to access the AdminPService EJB

AdminPRestService() - Constructor for class org.imixs.workflow.jaxrs.AdminPRestService

B

backup(String, String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

This method creates a backup of the result set form a JQPL query.

BPMNUnmarshaller - Class in org.imixs.workflow.jaxrs

The BPMNUnmarshaller converts a bpmn input stream into a BPMNModel instance.

BPMNUnmarshaller() - Constructor for class org.imixs.workflow.jaxrs.BPMNUnmarshaller

C

convertResult(ItemCollection, String, String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

This method converts a single ItemCollection into a Jax-rs response object.

convertResultList(List<ItemCollection>, String, String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

This method converts a ItemCollection List into a Jax-rs response object.

convertValuesToString(List) - Static method in class org.imixs.workflow.jaxrs.XMLItemCollectionWriter

This method converts the Values of a vector into a string representation.

countTotalHitsByQuery(String, int, String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

Returns a total hits for a lucene Search Query

countTotalPagesByQuery(String, int, String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

Returns the total pages for a lucene Search Query and a given page size.

D

deleteEntity(String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

This method deletes an entity

deleteEventLogEntry(String) - Method in class org.imixs.workflow.jaxrs.EventLogRestService

Deletes a eventLog entry by its $uniqueID

deleteJob(String) - Method in class org.imixs.workflow.jaxrs.AdminPRestService

This method deletes an entity

deleteModel(String) - Method in class org.imixs.workflow.jaxrs.ModelRestService

deleteReport(String) - Method in class org.imixs.workflow.jaxrs.ReportRestService

Deletes a report by name or by its $uniqueID or name.

DocumentCollectionWriter - Class in org.imixs.workflow.jaxrs

This MessageBodyWriter generates an HTML representation from a DocumetCollection

DocumentCollectionWriter() - Constructor for class org.imixs.workflow.jaxrs.DocumentCollectionWriter

DocumentRestService - Class in org.imixs.workflow.jaxrs

The DocumentService provides methods to access the DocumentService EJB

DocumentRestService() - Constructor for class org.imixs.workflow.jaxrs.DocumentRestService

DocumentTableWriter - Class in org.imixs.workflow.jaxrs

This MessageBodyWriter generates an HTML representation from a EntityTable.

DocumentTableWriter() - Constructor for class org.imixs.workflow.jaxrs.DocumentTableWriter

E

EventLogRestService - Class in org.imixs.workflow.jaxrs

The EventLogRestService supports methods to access the event log entries by different kind of request URIs

EventLogRestService() - Constructor for class org.imixs.workflow.jaxrs.EventLogRestService

F

findAllEventsByTask(String, int, String) - Method in class org.imixs.workflow.jaxrs.ModelRestService

findAllTasks(String, String) - Method in class org.imixs.workflow.jaxrs.ModelRestService

findDocumentsByJPQL(String, int, int, String, String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

Returns a resultset for a JPQL statement

findDocumentsByQuery(String, int, int, String, boolean, String, String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

Returns a resultset for a lucene Search Query

findTasksByGroup(String, String, String) - Method in class org.imixs.workflow.jaxrs.ModelRestService

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

fopTranformation(String, String, String, OutputStream) - Method in class org.imixs.workflow.jaxrs.ReportRestService

This method dos a apache FOP transformation using the FopFactory

G

getAllJobs() - Method in class org.imixs.workflow.jaxrs.AdminPRestService

Returns all existing jobs

getConfiguration(String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

Returns the IndexFieldListNoAnalyse from the lucensUpdateService

getCustomResult(String, int, int, String, boolean, String, UriInfo, HttpServletResponse) - Method in class org.imixs.workflow.jaxrs.ReportRestService

Returns a Datatable corresponding to the report definition and report content type.

getDefiniton(String, String) - Method in class org.imixs.workflow.jaxrs.ModelRestService

Returns the model definition containing general model information (e.g.

getDocument(String, String, String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

returns a single document defined by $uniqueid Regex for UID - e.g: bcc776f9-4e5a-4272-a613-9f5ebf35354d Snapshot: bcc776f9-4e5a-4272-a613-9f5ebf35354d-9b6655 deprecated format : 132d37bfd51-9a7868

getEventLogEntriesByTopic(String, int) - Method in class org.imixs.workflow.jaxrs.EventLogRestService

Returns a set of eventLog entries for a given topic.

getEvents(String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Returns a collection of events of a workitem, visible to the current user

getExcecuteReport(String, int, int, String, boolean, String, UriInfo) - Method in class org.imixs.workflow.jaxrs.ReportRestService

Executes a single report defined by name or uniqueid The output depends on the requested media format Since 2.1.2: the ReportService also supports FOP Transformation.

getGroups(String, String) - Method in class org.imixs.workflow.jaxrs.ModelRestService

Retuns a list of all Start Entities from each workflowgroup

getHelpHTML() - Method in class org.imixs.workflow.jaxrs.AdminPRestService

getHelpHTML() - Method in class org.imixs.workflow.jaxrs.DocumentRestService

getHelpHTML() - Method in class org.imixs.workflow.jaxrs.ReportRestService

getHelpHTML() - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

getHTMLResult(String, int, int, String, boolean, String, UriInfo, HttpServletResponse) - Method in class org.imixs.workflow.jaxrs.ReportRestService

Returns an HTML Stream with a HTML Datatable corresponding to the report query.

getItemList(String) - Static method in class org.imixs.workflow.jaxrs.DocumentRestService

This method returns a List object from a given comma separated string.

getJSONResult(String, int, int, String, boolean, String, UriInfo, HttpServletResponse) - Method in class org.imixs.workflow.jaxrs.ReportRestService

Returns a JSON stream from a report If a attribute list is defined in the report only the corresponding properties will be returend in the xml stream.

getModelFile(String, UriInfo) - Method in class org.imixs.workflow.jaxrs.ModelRestService

getModelOverview() - Method in class org.imixs.workflow.jaxrs.ModelRestService

getModelXML() - Method in class org.imixs.workflow.jaxrs.ModelRestService

getPdfReport(String, int, int, String, boolean, String, UriInfo) - Method in class org.imixs.workflow.jaxrs.ReportRestService

helper method for .pdf file extention

getReportDefinition(String) - Method in class org.imixs.workflow.jaxrs.ReportRestService

Returns a single report by name or by uniqueid

getReportsDefinitions() - Method in class org.imixs.workflow.jaxrs.ReportRestService

getRoot() - Method in class org.imixs.workflow.jaxrs.DocumentRestService

getRoot() - Method in class org.imixs.workflow.jaxrs.RootRestService

getSize(XMLDataCollection, Class<?>, Type, Annotation[], MediaType) - Method in class org.imixs.workflow.jaxrs.DocumentCollectionWriter

getSize(DocumentTable, Class<?>, Type, Annotation[], MediaType) - Method in class org.imixs.workflow.jaxrs.DocumentTableWriter

getSize(XMLDocument, Class<?>, Type, Annotation[], MediaType) - Method in class org.imixs.workflow.jaxrs.XMLItemCollectionWriter

getTask(String, int, String) - Method in class org.imixs.workflow.jaxrs.ModelRestService

getTaskListByAuthor(String, String, int, int, String, Boolean, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Returns a collection of workitems representing the worklist by the current user

getTaskListByCreator(String, String, int, int, String, Boolean, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

getTaskListByGroup(String, String, int, int, String, Boolean, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

getTaskListByOwner(String, String, int, int, String, Boolean, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

getTaskListByProcessID(int, String, int, int, String, Boolean, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

getTaskListByRef(String, String, int, int, String, Boolean, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

getWorkItem(String, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

returns a single workitem defined by $uniqueid

getWorkItemFile(String, String, UriInfo) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Returns a file attachment located in the property $file of the specified workitem The file name will be encoded.

getWorkList(String, int, int, String, Boolean, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Returns a collection of workitems representing the worklist by the current user

getXMLResult(String, int, int, String, boolean, String, UriInfo, HttpServletResponse) - Method in class org.imixs.workflow.jaxrs.ReportRestService

Returns a xml stream from a report If a attribute list is defined in the report only the corresponding properties will be returend in the xml stream.

I

isReadable(Class, Type, Annotation[], MediaType) - Method in class org.imixs.workflow.jaxrs.BPMNUnmarshaller

isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class org.imixs.workflow.jaxrs.DocumentCollectionWriter

isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class org.imixs.workflow.jaxrs.DocumentTableWriter

isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class org.imixs.workflow.jaxrs.XMLItemCollectionWriter

M

ModelRestService - Class in org.imixs.workflow.jaxrs

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

ModelRestService() - Constructor for class org.imixs.workflow.jaxrs.ModelRestService

O

org.imixs.workflow.jaxrs - package org.imixs.workflow.jaxrs

P

parseWorkitem(InputStream) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

This method expects a form post.

postBPMNModel(BPMNModel) - Method in class org.imixs.workflow.jaxrs.ModelRestService

postEntity(XMLDocument) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

The method saves a document provided in xml format.

postFormWorkitem(InputStream) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

This method expects a form post and processes the WorkItem by the WorkflowService EJB.

postFormWorkitemByUnqiueID(String, InputStream) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

This method expects a form post and processes the WorkItem by the WorkflowService EJB.

postJSONWorkitem(InputStream, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

This method expects a form post and processes the WorkItem by the WorkflowService EJB.

postJSONWorkitemByUniqueID(String, InputStream, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

postModel(XMLDataCollection) - Method in class org.imixs.workflow.jaxrs.ModelRestService

postModelByVersion(String, XMLDataCollection) - Method in class org.imixs.workflow.jaxrs.ModelRestService

postReport(XMLDocument) - Method in class org.imixs.workflow.jaxrs.ReportRestService

postWorkitemByUniqueIDJSONDeprecated(String, InputStream, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Deprecated.

postWorkitemJSONDeprecated(InputStream, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Deprecated.

postWorkitems_XML(XMLDataCollection) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

This method post a collection of ItemCollection objects to be processed by the WorkflowManager.

postXMLWorkitem(XMLDocument) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

This method post a ItemCollection object to be processed by the WorkflowManager.

postXMLWorkitemByUniqueID(String, XMLDocument) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

printHead(BufferedWriter, String, String) - Static method in class org.imixs.workflow.jaxrs.XMLItemCollectionWriter

This method prints the generic HTML Header for HTML output, including a default CSS definition for table layout.

printXMLItemCollectionHTML(BufferedWriter, XMLDocument) - Static method in class org.imixs.workflow.jaxrs.XMLItemCollectionWriter

This Method prints a single XMLItemCollection in html format.

putBPMNModel(BPMNModel) - Method in class org.imixs.workflow.jaxrs.ModelRestService

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

putEntity(XMLDocument) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

Delegater putEntity @PUT

putFormWorkitem(InputStream) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

This method expects a form post.

putJob(XMLDocument) - Method in class org.imixs.workflow.jaxrs.AdminPRestService

This method saves a entity provided in xml format Note: the method merges the content of the given entity into an existing one because the EntityService method save() did not merge an entity.

putJSONWorkitem(InputStream, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Delegater for PUT postXMLWorkitemByUniqueID

putJSONWorkitemByUniqueID(String, InputStream, String, String) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Delegater for PUT postJSONWorkitemByUniqueID

putModel(XMLDataCollection) - Method in class org.imixs.workflow.jaxrs.ModelRestService

This method updates a Model provided in a EntityCollection object.

putModelByVersion(String, XMLDataCollection) - Method in class org.imixs.workflow.jaxrs.ModelRestService

This method updates a Model provided in a EntityCollection object for a provided model version.

putReport(XMLDocument) - Method in class org.imixs.workflow.jaxrs.ReportRestService

This method updates or creates a Report object provided in a XMLItemCollection object

putWorkitems_XML(XMLDataCollection) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

putXMLWorkitem(XMLDocument) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Delegater

putXMLWorkitemByUniqueID(String, XMLDocument) - Method in class org.imixs.workflow.jaxrs.WorkflowRestService

Delegater for PUT postXMLWorkitemByUniqueID

R

readFrom(Class, Type, Annotation[], MediaType, MultivaluedMap, InputStream) - Method in class org.imixs.workflow.jaxrs.BPMNUnmarshaller

ReportRestService - Class in org.imixs.workflow.jaxrs

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

ReportRestService() - Constructor for class org.imixs.workflow.jaxrs.ReportRestService

restore(String) - Method in class org.imixs.workflow.jaxrs.DocumentRestService

This method restores a backup from the fileSystem

RootRestService - Class in org.imixs.workflow.jaxrs

The RootService provides the api description

RootRestService() - Constructor for class org.imixs.workflow.jaxrs.RootRestService

W

WorkflowRestService - Class in org.imixs.workflow.jaxrs

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

WorkflowRestService() - Constructor for class org.imixs.workflow.jaxrs.WorkflowRestService

writeTo(XMLDataCollection, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in class org.imixs.workflow.jaxrs.DocumentCollectionWriter

writeTo(DocumentTable, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in class org.imixs.workflow.jaxrs.DocumentTableWriter

This method prints the collection data into a HTML table

writeTo(XMLDocument, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in class org.imixs.workflow.jaxrs.XMLItemCollectionWriter

X

XMLItemCollectionWriter - Class in org.imixs.workflow.jaxrs

This class translates a XMLDocument into a HTML representation.

XMLItemCollectionWriter() - Constructor for class org.imixs.workflow.jaxrs.XMLItemCollectionWriter

A B C D E F G I M O P R W X