com.client.core.datatables.controller

Interface DataTablesController<T,ID>

Type Parameters:

T - entity that will be handled by the datatables, represent one JPA entity.

ID - the unique identifier of entity T

All Known Implementing Classes:

AbstractDataTablesController

public interface DataTablesController<T,ID>

Interface for all datatables request handling

Method Summary

Modifier and Type	Method and Description
java.lang.String	addRecord(T entity, org.springframework.validation.BindingResult validationResult, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Validates an entity and if validation passes adds that record.
void	configureTable(TableConfiguration<T,ID> tableConfig) Takes a StandardTableConfiguration and uses is to configure the controller.
java.lang.String	dashboardData(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Helper method to populate the transaction dashboard.
java.lang.String	deleteRecord(ID id) Deletes the record with unique identifier (such as primary key) id
java.lang.String	editEntityUsingForm(T entity, ID entityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Requests from the edit form will hit this method.
java.lang.String	editRecord(ID id, java.lang.Integer columnPosition, java.lang.String value, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Handles editing of records using the primary key, column position and new value for that column.
ApplicationSettings	getAppSettings()
java.lang.String	getCustomUrl()
DataTablesService<T,ID>	getDataTablesService()
T	getEntity()
org.apache.log4j.Logger	getLog()
java.lang.Class<T>	getType()
java.lang.String	getViewName()
java.lang.String	init(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Initializes the data table, this is the starting point when the page is hit.
void	populateFormWithNewEntity(javax.servlet.http.HttpServletRequest request, org.springframework.ui.Model model) Adds a new instance of T to the model to be used when adding a new entity T
java.lang.String	prepareFormForEditEntity(ID entityID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.ui.Model model) Validates an entity and if validation passes adds that record.
java.lang.String	updateRecord(T entity, org.springframework.validation.BindingResult validationResult, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Validates an entity and if validation passes updates that record.

Method Detail

configureTable

void configureTable(TableConfiguration<T,ID> tableConfig)

Takes a StandardTableConfiguration and uses is to configure the controller.

Parameters:

tableConfig -

populateFormWithNewEntity

void populateFormWithNewEntity(javax.servlet.http.HttpServletRequest request,
                               org.springframework.ui.Model model)
                        throws java.lang.InstantiationException,
                               java.lang.IllegalAccessException

Adds a new instance of T to the model to be used when adding a new entity T

Parameters:

model -

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

init

java.lang.String init(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      org.springframework.ui.Model model)

Initializes the data table, this is the starting point when the page is hit.

Parameters:

model -

Returns:

the view

dashboardData

java.lang.String dashboardData(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)

Helper method to populate the transaction dashboard. Called by the datatables in the dashboardMain.jsp

Parameters:

request -

response -

Throws:

java.io.IOException

editRecord

java.lang.String editRecord(ID id,
                            java.lang.Integer columnPosition,
                            java.lang.String value,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            org.springframework.ui.Model model)

Handles editing of records using the primary key, column position and new value for that column.

Parameters:

id - the primary key of the record

columnPosition - the column position in the table

value - the new value

request -

response -

model -

Returns:

the new value if successful edit, otherwise an error message

prepareFormForEditEntity

java.lang.String prepareFormForEditEntity(ID entityID,
                                          javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response,
                                          org.springframework.ui.Model model)

Validates an entity and if validation passes adds that record.

Parameters:

entity - The entity to add and validate

response -

Returns:

the primary key of the new record if successful insert, otherwise validation or error messages.

editEntityUsingForm

java.lang.String editEntityUsingForm(T entity,
                                     ID entityID,
                                     javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)

Requests from the edit form will hit this method. Validates an entity and if validation passes adds that record.

Parameters:

entity - The entity to add and validate

response -

Returns:

the primary key of the new record if successful insert, otherwise validation or error messages.

deleteRecord

java.lang.String deleteRecord(ID id)

Deletes the record with unique identifier (such as primary key) id

Parameters:

id - the unique identifier of the record

Returns:

a blank String if success, otherwise an error message.

addRecord

java.lang.String addRecord(T entity,
                           org.springframework.validation.BindingResult validationResult,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)

Validates an entity and if validation passes adds that record.

Parameters:

entity - The entity to add and validate

response -

Returns:

the primary key of the new record if successful insert, otherwise validation or error messages.

updateRecord

java.lang.String updateRecord(T entity,
                              org.springframework.validation.BindingResult validationResult,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)

Validates an entity and if validation passes updates that record.

Parameters:

entity - The entity to add and validate

response -

Returns:

the primary key of the new record if successful insert, otherwise validation or error messages.

getDataTablesService

DataTablesService<T,ID> getDataTablesService()

getLog

org.apache.log4j.Logger getLog()

getEntity

T getEntity()

getViewName

java.lang.String getViewName()

getCustomUrl

java.lang.String getCustomUrl()

getAppSettings

ApplicationSettings getAppSettings()

getType

java.lang.Class<T> getType()