Package com.groiss.smartclient

Class ObjectSelectProvider<T extends Persistent>

java.lang.Object

com.groiss.smartclient.JsonDataAdapter<T>

com.groiss.smartclient.ObjectSelectProvider<T>

All Implemented Interfaces:

JsonData, ReadWriteJsonData

public class ObjectSelectProvider<T extends Persistent>
extends JsonDataAdapter<T>
implements ReadWriteJsonData

default JsonDataAdapter implementation also supports data manipulation via ReadWriteJsonData

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowModifications
protected List<String>	displayFields
protected Set<String>	i18nFields
protected Map<String,String>	params

Fields inherited from class com.groiss.smartclient.JsonDataAdapter

config, objects, parameters, request, requestedId

Constructor Summary

Constructors

Constructor	Description
ObjectSelectProvider()

Method Summary

Modifier and Type	Method	Description
protected boolean	allowModifications()	Can be defined in the XML configuration, default is false (no insert, update, delete allowed).
final void	delete(Map<String,Object> data)	called for DELETE requests should delete the object provided in the JsonData.init(javax.servlet.http.HttpServletRequest, String, String, com.groiss.gui.NavigationTreeNode)
protected void	delete(T object, Map<String,Object> data)	Delete an object
protected T	get(String objectId)
protected Class<? extends T>	getBaseClass()
protected Map<String,Object>	getData(T p)
protected List<String>	getDisplayFields()
protected List<String>	getFields()	what object-properties should be used may be called multiple times
protected List<T>	getObjects()	get all required objects. basic filtering should be done here is called once
protected String	getRightId()	what right has to be checked when listing objects.
protected Object	getValue(T object, String field)	will be called for each object and each field
void	init(HttpServletRequest req, String par, String id, NavigationTreeNode configuration)	called once when initalizing the model
final String	insert(Map<String,Object> data)	called for POST requests should create a new object and return the new object's objectId after the successful operation, JsonData.getData() has to return a single row with the details for the new object
protected void	insert(T object, Map<String,Object> data)	Insert a new object
protected boolean	isCrudEnabled()	Deprecated, for removal: This API element is subject to removal in a future version. use allowModifications() instead
protected void	setValues(T o, Map<String,Object> data)
final void	update(Map<String,Object> data)	called for PUT requests update the object provided in the JsonData.init(javax.servlet.http.HttpServletRequest, String, String, com.groiss.gui.NavigationTreeNode) with the given data after the successful operation, JsonData.getData() has to return a single row with the details for the new object
protected void	update(T object, Map<String,Object> data)	Update an object

Methods inherited from class com.groiss.smartclient.JsonDataAdapter

getData, getFavorites, onRowComplete

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groiss.smartclient.JsonData

getData

Field Details

i18nFields

protected Set<String> i18nFields

params

protected Map<String,String> params

displayFields

protected List<String> displayFields

allowModifications

protected boolean allowModifications

Constructor Details

ObjectSelectProvider

public ObjectSelectProvider()

Method Details

isCrudEnabled

@Deprecated(since="11.0",
            forRemoval=true)
protected boolean isCrudEnabled()

Deprecated, for removal: This API element is subject to removal in a future version.

use allowModifications() instead

allowModifications

protected boolean allowModifications()

Can be defined in the XML configuration, default is false (no insert, update, delete allowed).

Returns:

the defined value

getRightId

protected String getRightId()

what right has to be checked when listing objects. "view" by default

Returns:

id of right to be checked

getDisplayFields

protected List<String> getDisplayFields()

getData

protected Map<String,Object> getData(T p)
                              throws Exception

Overrides:

getData in class JsonDataAdapter<T extends Persistent>

Throws:

Exception

init

public void init(HttpServletRequest req,
 String par,
 String id,
 NavigationTreeNode configuration)
          throws Exception

Description copied from interface: JsonData

called once when initalizing the model

Specified by:

init in interface JsonData

Overrides:

init in class JsonDataAdapter<T extends Persistent>

Parameters:

req - the current servlet-request

par - the trailing part of the REST-URL

id - the id when using single-object-requests

configuration - configuration node holding more information

Throws:

Exception

getObjects

protected List<T> getObjects()

Description copied from class: JsonDataAdapter

get all required objects. basic filtering should be done here is called once

Specified by:

getObjects in class JsonDataAdapter<T extends Persistent>

Returns:

get

protected T get(String objectId)

Overrides:

get in class JsonDataAdapter<T extends Persistent>

getFields

protected List<String> getFields()

Description copied from class: JsonDataAdapter

what object-properties should be used may be called multiple times

Specified by:

getFields in class JsonDataAdapter<T extends Persistent>

Returns:

getValue

protected Object getValue(T object,
 String field)
                   throws Exception

Description copied from class: JsonDataAdapter

will be called for each object and each field

Specified by:

getValue in class JsonDataAdapter<T extends Persistent>

Returns:

Throws:

Exception

getBaseClass

protected Class<? extends T> getBaseClass()

setValues

protected void setValues(T o,
 Map<String,Object> data)

insert

public final String insert(Map<String,Object> data)

Description copied from interface: ReadWriteJsonData

called for POST requests should create a new object and return the new object's objectId after the successful operation, JsonData.getData() has to return a single row with the details for the new object

Specified by:

insert in interface ReadWriteJsonData

Parameters:

data - the parameters provided from the request

Returns:

the new objectId

insert

protected void insert(T object,
 Map<String,Object> data)

Insert a new object

Parameters:

object - the new object

data - the parameters received from the request

update

public final void update(Map<String,Object> data)

Description copied from interface: ReadWriteJsonData

called for PUT requests update the object provided in the JsonData.init(javax.servlet.http.HttpServletRequest, String, String, com.groiss.gui.NavigationTreeNode) with the given data after the successful operation, JsonData.getData() has to return a single row with the details for the new object

Specified by:

update in interface ReadWriteJsonData

update

protected void update(T object,
 Map<String,Object> data)

Update an object

Parameters:

object - the object to update

data - the parameters received from the request

delete

public final void delete(Map<String,Object> data)

Description copied from interface: ReadWriteJsonData

called for DELETE requests should delete the object provided in the JsonData.init(javax.servlet.http.HttpServletRequest, String, String, com.groiss.gui.NavigationTreeNode)

Specified by:

delete in interface ReadWriteJsonData

delete

protected void delete(T object,
 Map<String,Object> data)

Delete an object

Parameters:

object - the object to delete

data - the parameters received from the request