org.imixs.workflow.jaxrs

Class DocumentRestService

java.lang.Object

org.imixs.workflow.jaxrs.DocumentRestService

public class DocumentRestService
extends Object

The DocumentService provides methods to access the DocumentService EJB

Author:

rsoika

Constructor Summary

Constructors

Constructor and Description
DocumentRestService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	backup(String query, String filepath) This method creates a backup of the result set form a JQPL query.
org.imixs.workflow.xml.XMLCount	countEntitiesByQuery(String query) Returns the size of a result set by Query
javax.ws.rs.core.Response	deleteEntity(String uniqueid) This method deletes an entity
org.imixs.workflow.xml.DocumentCollection	findDocumentsByQuery(String query, int pageSize, int pageIndex, String sortBy, boolean sortReverse, String items) Returns a result set by lucene Search Query
org.imixs.workflow.xml.XMLItemCollection	getConfiguration() Returns the IndexFieldListNoAnalyse from the lucensUpdateService
org.imixs.workflow.xml.XMLItemCollection	getDocument(String uniqueid, String items) returns a single document defined by $uniqueid
javax.ws.rs.core.StreamingOutput	getHelpHTML()
javax.ws.rs.core.Response	putEntity(org.imixs.workflow.xml.XMLItemCollection xmlworkitem) The method saves a document provided in xml format.
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

DocumentRestService

public DocumentRestService()

Method Detail

getHelpHTML

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

getDocument

public org.imixs.workflow.xml.XMLItemCollection getDocument(String uniqueid,
                                                            String items)

returns a single document defined by $uniqueid

Parameters:

uniqueid -

Returns:

findDocumentsByQuery

public org.imixs.workflow.xml.DocumentCollection findDocumentsByQuery(String query,
                                                                      int pageSize,
                                                                      int pageIndex,
                                                                      String sortBy,
                                                                      boolean sortReverse,
                                                                      String items)

Returns a result set by lucene Search Query

Parameters:

query -

pageSize -

pageIndex -

items -

Returns:

countEntitiesByQuery

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

Returns the size of a result set by Query

Parameters:

query -

Returns:

putEntity

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

The method saves a document provided in xml format. The caller need to be assigned to the access role 'org.imixs.ACCESSLEVEL.MANAGERACCESS' Note: the method merges the content of the given document into an existing one because the DocumentService 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 DocumentService 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:

getConfiguration

public org.imixs.workflow.xml.XMLItemCollection getConfiguration()
                                                          throws Exception

Returns the IndexFieldListNoAnalyse from the lucensUpdateService

Returns:

Throws:

Exception