Package com.aquima.web.rest.v1.controller

Class ShortcutsRestController

java.lang.Object

com.aquima.web.rest.v1.controller.RestControllerBase

com.aquima.web.rest.v1.controller.ShortcutsRestController

@RestController
@RestApiContext
@RequestMapping(value="/shortcuts",
                produces="application/json")
public class ShortcutsRestController
extends RestControllerBase

Provides information about shortcuts.

Since:

9.6

Author:

Radu Batori, Voicu Moldovan

Field Summary

Fields

Modifier and Type	Field	Description
static String	MAPPING
static String	NAME

Fields inherited from class com.aquima.web.rest.v1.controller.RestControllerBase

DEFAULT_PAGE_NUMBER, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor	Description
ShortcutsRestController(com.blueriq.component.api.shortcut.IShortcutManager shortcutManager)

Method Summary

Modifier and Type	Method	Description
Shortcut	getShortcut(String name)	Returns a shortcut by name.
PagedShortcuts	getShortcuts(Integer page, Integer pageSize, String sortParameter)	Returns a paged view of all available shortcuts

Methods inherited from class com.aquima.web.rest.v1.controller.RestControllerBase

getFilters, getUser

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

MAPPING

public static final String MAPPING

See Also:

Constant Field Values

Constructor Detail

ShortcutsRestController

@Autowired
public ShortcutsRestController(com.blueriq.component.api.shortcut.IShortcutManager shortcutManager)

Method Detail

getShortcuts

@RequestMapping(method=GET)
@ResponseStatus(OK)
@ResponseBody
public PagedShortcuts getShortcuts(@RequestParam(required=false)
                                   Integer page,
                                   @RequestParam(required=false)
                                   Integer pageSize,
                                   @RequestParam(value="sort",required=false)
                                   String sortParameter)

Returns a paged view of all available shortcuts

Parameters:

page - The page number. Not required.

pageSize - The items per page. Not required.

sortParameter - The properties to sort on. Comma separated. Not required.

Returns:

The list of shortcuts.

getShortcut

@RequestMapping(value="/{name}",
                method=GET)
@ResponseStatus(OK)
@ResponseBody
public Shortcut getShortcut(@PathVariable("name")
                            String name)

Returns a shortcut by name.

Parameters:

name - The name of the shortcut

Returns:

The shortcut resource