org.imixs.workflow.jaxrs

Class EntityRestService

java.lang.Object

org.imixs.workflow.jaxrs.EntityRestService

public class EntityRestService
extends Object

The EntityService provides methods to access the EntityService EJB

Author:

rsoika

Constructor Summary

Constructors

Constructor and Description
EntityRestService()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addIndex(String name, int type) Adds a new Imixs-Entity-Index to index list of the Imixs EntityService
javax.ws.rs.core.Response	backup(String query, String filepath) This method creates a backup of the result set form a JQPL query.
javax.ws.rs.core.Response	deleteEntity(String uniqueid) This method deletes an entity
javax.ws.rs.core.Response	deleteIndex(String name) Removes an Imixs-Entity-Index from index list of the Imixs EntityService
org.imixs.workflow.xml.EntityCollection	getEntitiesByQuery(String query, int start, int count, String items) Returns a result set by JPQL Query
org.imixs.workflow.xml.EntityCollection	getEntitiesByQueryJSON(String query, int start, int count, String items)
org.imixs.workflow.xml.EntityCollection	getEntitiesByQueryXML(String query, int start, int count, String items)
javax.ws.rs.core.StreamingOutput	getHelpHTML()
javax.ws.rs.core.Response	getIndexList() Returns the entityService index list in XML or JSON format
org.imixs.workflow.xml.XMLCount	getWorkListCountByQuery(String query) Returns the size of a result set by JPQL Query
javax.ws.rs.core.Response	putEntity(org.imixs.workflow.xml.XMLItemCollection xmlworkitem) 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.
javax.ws.rs.core.Response	restore(String filepath) This method restores a backup from the fileSystem

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityRestService

public EntityRestService()

Method Detail

getHelpHTML

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

getEntitiesByQuery

public org.imixs.workflow.xml.EntityCollection getEntitiesByQuery(String query,
                                                         int start,
                                                         int count,
                                                         String items)

Returns a result set by JPQL Query

Parameters:

query -

start -

count -

type -

sortorder -

items -

Returns:

getEntitiesByQueryXML

public org.imixs.workflow.xml.EntityCollection getEntitiesByQueryXML(String query,
                                                            int start,
                                                            int count,
                                                            String items)

getEntitiesByQueryJSON

public org.imixs.workflow.xml.EntityCollection getEntitiesByQueryJSON(String query,
                                                             int start,
                                                             int count,
                                                             String items)

getWorkListCountByQuery

public org.imixs.workflow.xml.XMLCount getWorkListCountByQuery(String query)

Returns the size of a result set by JPQL Query

Parameters:

query -

Returns:

getIndexList

public javax.ws.rs.core.Response getIndexList()

Returns the entityService index list in XML or JSON format

Returns:

addIndex

public javax.ws.rs.core.Response addIndex(String name,
                                 int type)

Adds a new Imixs-Entity-Index to index list of the Imixs EntityService

Parameters:

name - - name of index field

type - - index type

Returns:

deleteIndex

public javax.ws.rs.core.Response deleteIndex(String name)

Removes an Imixs-Entity-Index from index list of the Imixs EntityService

Parameters:

title - - name of index field

putEntity

public javax.ws.rs.core.Response putEntity(org.imixs.workflow.xml.XMLItemCollection xmlworkitem)

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. But the rest service typically consumes only a subset of attributes. So this is the reason why we merge the entity here. In different to the behavior of the EntityService the WorkflowService method process() did this merge automatically.

Parameters:

xmlworkitem - - entity to be saved

Returns:

deleteEntity

public javax.ws.rs.core.Response deleteEntity(String uniqueid)

This method deletes an entity

backup

public javax.ws.rs.core.Response backup(String query,
                               String filepath)

This method creates a backup of the result set form a JQPL query. The entity list will be stored into the file system. The backup can be restored by calling the restore method

Parameters:

query -

start -

count -

filepath - - path in server filesystem

Returns:

restore

public javax.ws.rs.core.Response restore(String filepath)

This method restores a backup from the fileSystem

Parameters:

filepath - - path in server fileSystem

Returns: