com.edorasware.rest.action

Class ActionController

java.lang.Object

com.edorasware.rest.action.ActionController

@Controller
public class ActionController
extends Object

Controller that provides allowed Actions for specific contexts and specific AnyWorkObjects.

Constructor Summary

Constructors

Constructor and Description
ActionController(ActionManager actionManager)

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<FrontendAction>	getActionById(String actionId, String workObjectGlobalId, Locale locale) Returns the Action instance for the given action id.
org.springframework.http.ResponseEntity<List<FrontendActionGroup>>	getAllowedActionsForCurrentUser(String contextId, String workObjectGlobalId, Locale locale) Returns the allowed actions for the specified context and specific com.edorasware.commons.core.any.WorkObjectId.
org.springframework.http.ResponseEntity<List<FrontendAction>>	getAllowedActionsForType(String typeId, String qualifier, Locale locale) Returns the allowed actions for the specified Type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionController

public ActionController(ActionManager actionManager)

Method Detail

getAllowedActionsForCurrentUser

@RequestMapping(value="/permissions/actions/context/{contextId}",
                method=GET)
 @ResponseBody
public org.springframework.http.ResponseEntity<List<FrontendActionGroup>> getAllowedActionsForCurrentUser(@PathVariable
                                                                                                                                                                                                                       String contextId,
                                                                                                                                                                                                                       @RequestParam(value="workObjectGlobalId",required=false)
                                                                                                                                                                                                                       String workObjectGlobalId,
                                                                                                                                                                                                                       Locale locale)

Returns the allowed actions for the specified context and specific com.edorasware.commons.core.any.WorkObjectId.

Parameters:

contextId - the specified action context

workObjectGlobalId - the specified work object global ID

locale - the translation locale

Returns:

the allowed actions

getAllowedActionsForType

@RequestMapping(value="/permissions/actions/type/{typeId}",
                method=GET)
 @ResponseBody
public org.springframework.http.ResponseEntity<List<FrontendAction>> getAllowedActionsForType(@PathVariable
                                                                                                                                                                                                     String typeId,
                                                                                                                                                                                                     @RequestParam(required=false)
                                                                                                                                                                                                     String qualifier,
                                                                                                                                                                                                     Locale locale)

Returns the allowed actions for the specified Type.

Parameters:

typeId - the specified entity type

qualifier - the specified entity type qualifier

locale - the translation locale

Returns:

the allowed actions for the specified type

getActionById

@RequestMapping(value="/permissions/actions/{actionId}",
                method=GET)
 @ResponseBody
public org.springframework.http.ResponseEntity<FrontendAction> getActionById(@PathVariable
                                                                                                                                                                                 String actionId,
                                                                                                                                                                                 @RequestParam(value="workObjectGlobalId",required=false)
                                                                                                                                                                                 String workObjectGlobalId,
                                                                                                                                                                                 Locale locale)

Returns the Action instance for the given action id. If the action id is not known a unknown action object is returned, such that the client is able to check that this id is not known instead of throwing an exception.

Parameters:

actionId - the action id for which the action instance should be created

workObjectGlobalId - the work object global ID

locale - the translation locale

Returns:

the action instance for the given action id