com.edorasware.cmmn.one.rest

Class CmmnRestService

java.lang.Object

com.edorasware.cmmn.one.rest.CmmnRestService

@Controller
@Transactional
@RequestMapping(value="/cmmn")
public class CmmnRestService
extends Object

Constructor Summary

Constructors

Constructor and Description
CmmnRestService()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<List<com.edorasware.cmmn.model.statesandactions.AvailableAction>>	availableActions(String caseClientId, javax.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<org.springframework.http.HttpStatus>	caseFileItemTransition(String caseClientId, String caseFileItemId, String caseFileItemTransition, javax.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<org.springframework.http.HttpStatus>	caseFileItemTransitionWithFormData(String caseClientId, String caseFileItemId, String caseFileItemTransition, FrontendObject frontendObject)
protected Map<String,String>	createForwardMap(com.edorasware.cmmn.model.structure.PlanItem planItem) Create a suitable result map of the form: {"forwardTo" : ""}.
org.springframework.http.ResponseEntity<List<com.edorasware.cmmn.model.statesandactions.CurrentState>>	currentStates(String caseClientId, javax.servlet.http.HttpServletRequest request)
protected List<com.edorasware.cmmn.model.statesandactions.AvailableAction>	defaultActions(String caseId) Hook method allowing to return any list of actions.
protected List<com.edorasware.cmmn.model.statesandactions.CurrentState>	defaultStates(String caseId) Hook method allowing to return any list of states.
org.springframework.http.ResponseEntity<org.springframework.http.HttpStatus>	discretionaryItemPlanning(String caseClientId, String discretionaryItemId, javax.servlet.http.HttpServletRequest request)
protected boolean	isCurrentUserAllowedToBrowseToWorkObject(com.edorasware.commons.core.any.AnyWorkObject workObject)
org.springframework.http.ResponseEntity<List<Map<String,Object>>>	planItemProperties(String caseClientId, String properties, javax.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<Map<String,Object>>	planItemPropertiesSingle(String caseClientId, String planItemId, String properties, javax.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<Map<String,String>>	planItemTransition(String caseClientId, String planItemId, String planItemTransition, javax.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<Map<String,String>>	planItemTransitionWithFormData(String caseClientId, String planItemId, String planItemTransition, FrontendObject frontendObject)
org.springframework.http.ResponseEntity<org.springframework.http.HttpStatus>	stateUpdate(String caseClientId, javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Constructor Detail

CmmnRestService

public CmmnRestService()

Method Detail

stateUpdate

@Transactional
@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/stateUpdate",
                method=GET)
public org.springframework.http.ResponseEntity<org.springframework.http.HttpStatus> stateUpdate(@PathVariable
                                                                                                                                 String caseClientId,
                                                                                                                                 javax.servlet.http.HttpServletRequest request)

planItemTransition

@Transactional
@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/{planItemId}/{planItemTransition}/planItemTransition",
                method=GET)
public org.springframework.http.ResponseEntity<Map<String,String>> planItemTransition(@PathVariable
                                                                                                                       String caseClientId,
                                                                                                                       @PathVariable
                                                                                                                       String planItemId,
                                                                                                                       @PathVariable
                                                                                                                       String planItemTransition,
                                                                                                                       javax.servlet.http.HttpServletRequest request)

planItemTransitionWithFormData

@Transactional
@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/{planItemId}/{planItemTransition}/planItemTransitionWithFormData",
                method=PUT)
public org.springframework.http.ResponseEntity<Map<String,String>> planItemTransitionWithFormData(@PathVariable
                                                                                                                                   String caseClientId,
                                                                                                                                   @PathVariable
                                                                                                                                   String planItemId,
                                                                                                                                   @PathVariable
                                                                                                                                   String planItemTransition,
                                                                                                                                   @RequestBody
                                                                                                                                   FrontendObject frontendObject)

caseFileItemTransition

@Transactional
@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/{caseFileItemId}/{caseFileItemTransition}/caseFileItemTransition",
                method=GET)
public org.springframework.http.ResponseEntity<org.springframework.http.HttpStatus> caseFileItemTransition(@PathVariable
                                                                                                                                            String caseClientId,
                                                                                                                                            @PathVariable
                                                                                                                                            String caseFileItemId,
                                                                                                                                            @PathVariable
                                                                                                                                            String caseFileItemTransition,
                                                                                                                                            javax.servlet.http.HttpServletRequest request)

caseFileItemTransitionWithFormData

@Transactional
@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/{caseFileItemId}/{caseFileItemTransition}/caseFileItemTransitionWithFormData",
                method=PUT)
public org.springframework.http.ResponseEntity<org.springframework.http.HttpStatus> caseFileItemTransitionWithFormData(@PathVariable
                                                                                                                                                        String caseClientId,
                                                                                                                                                        @PathVariable
                                                                                                                                                        String caseFileItemId,
                                                                                                                                                        @PathVariable
                                                                                                                                                        String caseFileItemTransition,
                                                                                                                                                        @RequestBody
                                                                                                                                                        FrontendObject frontendObject)

discretionaryItemPlanning

@Transactional
@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/{discretionaryItemId}/discretionaryItemPlanning",
                method=GET)
public org.springframework.http.ResponseEntity<org.springframework.http.HttpStatus> discretionaryItemPlanning(@PathVariable
                                                                                                                                               String caseClientId,
                                                                                                                                               @PathVariable
                                                                                                                                               String discretionaryItemId,
                                                                                                                                               javax.servlet.http.HttpServletRequest request)

currentStates

@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/currentStates",
                method=GET)
public org.springframework.http.ResponseEntity<List<com.edorasware.cmmn.model.statesandactions.CurrentState>> currentStates(@PathVariable
                                                                                                                                               String caseClientId,
                                                                                                                                               javax.servlet.http.HttpServletRequest request)

availableActions

@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/availableActions",
                method=GET)
public org.springframework.http.ResponseEntity<List<com.edorasware.cmmn.model.statesandactions.AvailableAction>> availableActions(@PathVariable
                                                                                                                                                     String caseClientId,
                                                                                                                                                     javax.servlet.http.HttpServletRequest request)

planItemPropertiesSingle

@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/planItemPropertiesSingle",
                method=GET)
public org.springframework.http.ResponseEntity<Map<String,Object>> planItemPropertiesSingle(@PathVariable
                                                                                                               String caseClientId,
                                                                                                               @RequestParam(value="planItemId")
                                                                                                               String planItemId,
                                                                                                               @RequestParam(value="properties")
                                                                                                               String properties,
                                                                                                               javax.servlet.http.HttpServletRequest request)

planItemProperties

@ResponseBody
@RequestMapping(value="/CAS/{caseClientId}/planItemProperties",
                method=GET)
public org.springframework.http.ResponseEntity<List<Map<String,Object>>> planItemProperties(@PathVariable
                                                                                                               String caseClientId,
                                                                                                               @RequestParam(value="properties")
                                                                                                               String properties,
                                                                                                               javax.servlet.http.HttpServletRequest request)

createForwardMap

protected Map<String,String> createForwardMap(com.edorasware.cmmn.model.structure.PlanItem planItem)

Create a suitable result map of the form: {"forwardTo" : ""}. The method returns null, if no forwarding has to be performed (e.g. becuause the user doesn't have suitable permission on the target Work Item or if a started CaseTask is a root case.

isCurrentUserAllowedToBrowseToWorkObject

protected boolean isCurrentUserAllowedToBrowseToWorkObject(com.edorasware.commons.core.any.AnyWorkObject workObject)

defaultStates

protected List<com.edorasware.cmmn.model.statesandactions.CurrentState> defaultStates(String caseId)

Hook method allowing to return any list of states. The method is only called for non-CMMN cases. The default implementation returns an empty list.

Parameters:

caseId - the case Id.

Returns:

the list of states for the case identified by caseId.

defaultActions

protected List<com.edorasware.cmmn.model.statesandactions.AvailableAction> defaultActions(String caseId)

Hook method allowing to return any list of actions. The method is only called for non-CMMN cases. The default implementation returns an empty list.

Parameters:

caseId - the case Id.

Returns:

the list of actions for the case identified by caseId.