Frontend Play

** WORK IN PROGRESS **

Table Of Content

User Related Actions

Action	Call
Login User	jsRoutes.controllers.User.login()
Logout User	jsRoutes.controllers.User.logout()
Get Maps of User on Server	jsRoutes.controllers.User.mapListFromDB()

Mindmap Related Actions

Get Information

Action	Call
Get (complete/chunked) Mindmap as Json	jsRoutes.controllers.MindMap.map(String mapId) jsRoutes.controllers.MindMap.map(String mapId, Integer nodeCount)
Get Node with all/some Children as Json	jsRoutes.controllers.MindMap.getNode(String mapId, String nodeId) jsRoutes.controllers.MindMap.getNode(String mapId, String nodeId, Integer nodeCount)

Gaining and Releasing locks

Action	Call
Request Lock for a Node	jsRoutes.controllers.MindMap.requestLock(String mapId)
Release Lock for a Node	jsRoutes.controllers.MindMap.releaseLock(String mapId)

Modifying a Mindmap

Action	Call
Create Node in Map	jsRoutes.controllers.MindMap.createNode(String mapId)
Change Node in Map	jsRoutes.controllers.MindMap.changeNode(String mapId)
Delete Node in Map	jsRoutes.controllers.MindMap.deleteNode(String mapId)

Detailed Informations

Login

Method	POST
Action	jsRoutes.controllers.User.login()
Form Data	username: String password: String
Requires	Nothing
Returns	303 Redirect

Logout

Method	GET
Action	jsRoutes.controllers.User.logout()
Form Data	---
Requires	Logged in User
Returns	303 Redirect

Map Info From Database

Method	GET
Action	jsRoutes.controllers.User.mapListFromDB()
Form Data	---
Requires	Logged in User
Returns	List with MindMapInfo Objects

Mindmap As Json

Method	GET
Action	jsRoutes.controllers.MindMap.map(String mapId) jsRoutes.controllers.MindMap.map(String mapId, Integer nodeCount)
Params	mapId = Id of the map (currently mmIdOnServer) nodeCount = soft limit of maximum nodes
Form Data	---
Requires	Logged in User Right to Access Map>
Returns	A MindMap Object

Node As Json

Method	GET
Action	jsRoutes.controllers.MindMap.getNode(String mapId,Strin nodeId) jsRoutes.controllers.MindMap.getNode(String mapId,Strin nodeId, Integer nodeCount)
Params	mapId = Id of the map (currently mmIdOnServer) nodeId = Id of node nodeCount = soft limit of maximum nodes
Form Data	---
Requires	Logged in User Right to Access Map>
Returns	A DefaultNode Object

Request Lock

Method	POST
Action	jsRoutes.controllers.MindMap.requestLock(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	nodeId = Id of Node
Requires	Logged in User Right to Access Map Nobody else has lock on the node
Returns	Status 200 OK = success Status 403 Forbidden = failure

Release Lock

Method	POST
Action	jsRoutes.controllers.MindMap.releaseLock(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	nodeId = Id of Node
Requires	Logged in User Right to Access Map Lock on Node
Returns	Status 200 OK = success Status 403 Forbidden = failure

Create Node

Method	POST
Action	jsRoutes.controllers.MindMap.createNode(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	parentNodeId = Id of parent where the new node gets attached to
Requires	Logged in User Right to Access Map
Returns	A DefaultNode Object, which represents the created node

Remove Node

Method	DELETE
Action	jsRoutes.controllers.MindMap.deleteNode(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	nodeId = Id of node to delete
Requires	Logged in User Right to Access Map No Lock on node or child node
Returns	Status 200 OK = success Status 403 Forbidden = failure

Change Node

Method	POST
Action	jsRoutes.controllers.MindMap.changeNode(String mapId)
Params	mapId = Id of the map (currently mmIdOnServer)
Form Data	WILL BE ADDED
Requires	Logged in User Right to Access Map Lock on Node
Returns	WILL BE ADDED