|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.opensubsystems.core.www.WebSessionServlet
org.opensubsystems.core.www.WebUIServlet
org.opensubsystems.patterns.listdata.www.ListBrowserServlet
public class ListBrowserServlet
Servlet responsible for loading list of data objects based on various criteria at specified position within larger set of data. This servlet contains read-only functionality so it can be safely used, when user isn't be allowed to modify the data.
| Field Summary | |
|---|---|
static int |
ACTION_GO_TO_PAGE_ID
Names of the action to display specific page. |
static java.lang.String |
ACTION_GO_TO_PAGE_NAME
Names of the action to display specific page. |
static int |
ACTION_NEXT_PAGE_ID
Names of the action to display next page. |
static java.lang.String |
ACTION_NEXT_PAGE_NAME
Names of the action to display next page. |
static int |
ACTION_PAGE_SIZE_ID
Names of the action to submit page size change. |
static java.lang.String |
ACTION_PAGE_SIZE_NAME
Names of the action to submit page size change. |
static int |
ACTION_PREV_PAGE_ID
Names of the action to display previous page. |
static java.lang.String |
ACTION_PREV_PAGE_NAME
Names of the action to display previous page. |
static int |
ACTION_SET_FILTER_ID
Names of the action to submit list filter change. |
static java.lang.String |
ACTION_SET_FILTER_NAME
Names of the action to submit list filter change. |
static int |
ACTION_SET_ORDER_ID
Names of the action to submit order change ascending. |
static java.lang.String |
ACTION_SET_ORDER_NAME
Names of the action to submit order change. |
static int |
ACTION_SHOW_LIST_ID
Names of the action to display list with default parameters. |
static java.lang.String |
ACTION_SHOW_LIST_NAME
Names of the action to display list with default parameters. |
static int |
FORM_COUNT_LISTBROWSER
How many actions this servlet recognizes. |
static java.lang.String |
LIST_PARAM_ACTUAL_PAGE
Parameter used to specify the actual page of the loaded items. |
static java.lang.String |
LIST_PARAM_BEGIN_POSITION
Parameter used to specify the position of the first loaded item in the list. |
static java.lang.String |
LIST_PARAM_CLIENT_ORDER_CODE
Parameter used to specify what column(s) to use for sorting the loaded portion of the data on the client. |
static java.lang.String |
LIST_PARAM_CLIENT_ORDER_TYPE
Parameter used to specify what directions should the loaded portion of the data be sorted on the client. |
static java.lang.String |
LIST_PARAM_END_POSITION
Parameter used to specify the position of the last loaded item in the list. |
static java.lang.String |
LIST_PARAM_EXTRA_CONDITION_ATTRIBUTE
Parameter specifying what attribute of the items in the list does the extra condition applies to. |
static java.lang.String |
LIST_PARAM_EXTRA_CONDITION_OPERATION
Parameter specifying what operations to apply on the attribute of the items in the list does the extra condition applies to. |
static java.lang.String |
LIST_PARAM_EXTRA_CONDITION_VALUE
Parameter specifying the value for the operation applied to the attribute of the items in the list does the extra condition applies to. |
static java.lang.String |
LIST_PARAM_EXTRA_CONDITION_VALUE_TYPE
Parameter specifying type of value for the operation applied to the attribute of the items in the list does the extra condition applies to. |
static java.lang.String |
LIST_PARAM_FIRST_VISIBLE_ITEM
Parameter used to specify what should be the first visible item from the list of loaded items on the client (for example in the case the list is too long and needs to be scrolled to show the specific item). |
static java.lang.String |
LIST_PARAM_IGNORED_ITEMS
Parameter specifying comma separated list of items to do not load. |
static java.lang.String |
LIST_PARAM_KEEP_SELECTED
Parameter specifying if the selected items should be loaded even if they wouldn't be normally in the list. |
static java.lang.String |
LIST_PARAM_LIST_DOMAIN_ID
Parameter specifying id of the domain from which to load items. |
static java.lang.String |
LIST_PARAM_LIST_FILTER_ID
Parameter used to identify filter to apply to the list. |
static java.lang.String |
LIST_PARAM_LIST_PAGE_SIZE
Parameter used to specify how many items to retrieve at once. |
static java.lang.String |
LIST_PARAM_LIST_PARENT_DATA_TYPE
Parameter specifying data type of item which should be parent to all loaded items in the list. |
static java.lang.String |
LIST_PARAM_LIST_PARENT_IDENTIFIER
Parameter specifying identification of item which should be parent to all loaded items in the list. |
static java.lang.String |
LIST_PARAM_MARKED_ITEMS
Parameter specifying comma separated list of highlighted items. |
static java.lang.String |
LIST_PARAM_ORDER_CODE
Parameter used to specify what column(s) to use for sorting the list. |
static java.lang.String |
LIST_PARAM_ORDER_TYPE
Parameter used to specify what directions should the list be sorted in. |
static java.lang.String |
LIST_PARAM_SELECTED_ITEMS
Parameter specifying comma separated list of selected items. |
static java.lang.String |
LIST_PARAM_SHOW_COLUMN_CODES
Parameter used to specify what columns to display for each item in the list on the client. |
static java.lang.String |
LISTBROWSER_DATA_FACTORY_CLASS_NAME
Names of the list options parameter in request forward. |
static java.lang.String |
LISTBROWSER_ITEM_ID_EXTENTION_SEPARATOR
Constant for special ID extention separator. |
static java.lang.String |
LISTBROWSER_LIST_MAIN_PAGE
Name of the property for page which is the main entry point to the list. |
protected java.lang.Class |
m_clsFactory
Class representing the factory used to load data |
protected java.lang.String |
m_strFactoryClassName
List data factory class name to be used by this servlet |
static java.lang.String |
PARAMETER_DATA_OBJECT_LIST_NAME
Names of the data object list parameter in request forward. |
static java.lang.String |
PARAMETER_GENERIC_DATA_LIST_NAME
Names of the data object list parameter in request forward. |
static java.lang.String |
PARAMETER_LIST_OPTIONS_NAME
Names of the list options parameter in request forward. |
| Fields inherited from class org.opensubsystems.core.www.WebUIServlet |
|---|
DATA_ATTRIBUTE_REQUEST_PARAM, FORCE_MAXIMIZE_PARAM, FORM_COUNT_WEBUI, FORM_NAME_REQUEST_PARAM, FORM_UNKNOWN_ID, LOGGEDIN_REQUEST_PARAM, m_strMessageStyleSheet, ORIGINAL_REQUEST_INFO_REQUEST_PARAM, PAGE_TITLE_REQUEST_PARAM, WEBUI_MESSAGEBOX_PAGE, WEBUI_MESSAGEBOX_STYLE_SHEET |
| Fields inherited from class org.opensubsystems.core.www.WebSessionServlet |
|---|
APPLICATION_SECURE, ATTACH_INTERNAL_SESSION_ID_URL_PARAM, DEFAULT_APPLICATION_SECURE, DEFAULT_LOGIN_SECURE, LOGIN_FORWARD_SESSION_PARAM, LOGIN_SECURE, m_scServletContext, m_sessionValidator, m_strHandshakeURL, s_bApplicationSecure, s_bLoginSecure, SERVLET_PATH_REQUEST_PARAM, SESSION_VALIDATOR_CLASS, WEBSESSION_DISPATCHER_CACHED, WEBSESSION_DISPATCHER_CACHED_DEFAULT, WEBSESSION_HADSHAKE_REQUIRED_DEFAULT, WEBSESSION_HANDSHAKE_REQUIRED, WEBSESSION_HANDSHAKE_URL, WEBSESSION_LOGIN_REQUIRED, WEBSESSION_LOGIN_REQUIRED_DEFAULT, WEBSESSION_LOGIN_URL |
| Constructor Summary | |
|---|---|
ListBrowserServlet()
|
|
| Method Summary | |
|---|---|
protected void |
completeAction(java.lang.Object[] listInfo,
javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse,
java.lang.String strUIID)
Populate request and response with result of the operation. |
protected void |
doGet(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
|
protected void |
doPost(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
|
protected int |
getFormToProcess(javax.servlet.http.HttpServletRequest hsrqRequest)
|
protected ListController |
getListController()
Get list controller to use during this request. |
java.lang.String |
getServletInfo()
|
void |
init(javax.servlet.ServletConfig scConfig)
|
protected ListOptions |
parseListFromRequest(javax.servlet.http.HttpServletRequest hsrqRequest,
int actionCode)
Create new instance of list from a HTTP request. |
protected void |
processSetExactPage(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
Process action to show exact-selected page of the list. |
protected void |
processSetListFilter(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
Process action to show list with new filter and its paramaters. |
protected void |
processSetNextPage(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
Process action to show next page of the list. |
protected void |
processSetOrder(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
Process action to show list with new order column - ASC. |
protected void |
processSetPageSize(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
Process action to show list for new page size. |
protected void |
processSetPrevPage(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
Process action to show previous page of the list. |
protected void |
processShowList(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
Process action to show default list. |
| Methods inherited from class org.opensubsystems.core.www.WebUIServlet |
|---|
cacheDispatcher, cacheUIPath, displayUI, messageBoxPage, messageBoxPage, preservice, setLoggedInFlag |
| Methods inherited from class org.opensubsystems.core.www.WebSessionServlet |
|---|
destroy, getLoginRedirect, handleNewSession, isApplicationSecure, isDispatcherCachingEnabled, isLoginSecure, redirect, redirectToHandshake, redirectToLogin, resetLoginRedirect, saveLoginRedirect, service, shouldRequestBeSecure, verifyLogin |
| Methods inherited from class javax.servlet.http.HttpServlet |
|---|
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service |
| Methods inherited from class javax.servlet.GenericServlet |
|---|
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String LISTBROWSER_LIST_MAIN_PAGE
public static final java.lang.String LISTBROWSER_DATA_FACTORY_CLASS_NAME
public static final java.lang.String LISTBROWSER_ITEM_ID_EXTENTION_SEPARATOR
public static final java.lang.String PARAMETER_DATA_OBJECT_LIST_NAME
public static final java.lang.String PARAMETER_GENERIC_DATA_LIST_NAME
public static final java.lang.String PARAMETER_LIST_OPTIONS_NAME
public static final java.lang.String ACTION_SHOW_LIST_NAME
public static final java.lang.String ACTION_SET_FILTER_NAME
public static final java.lang.String ACTION_SET_ORDER_NAME
public static final java.lang.String ACTION_PAGE_SIZE_NAME
public static final java.lang.String ACTION_PREV_PAGE_NAME
public static final java.lang.String ACTION_NEXT_PAGE_NAME
public static final java.lang.String ACTION_GO_TO_PAGE_NAME
public static final int ACTION_SHOW_LIST_ID
public static final int ACTION_SET_FILTER_ID
public static final int ACTION_SET_ORDER_ID
public static final int ACTION_PAGE_SIZE_ID
public static final int ACTION_PREV_PAGE_ID
public static final int ACTION_NEXT_PAGE_ID
public static final int ACTION_GO_TO_PAGE_ID
public static final int FORM_COUNT_LISTBROWSER
public static final java.lang.String LIST_PARAM_LIST_FILTER_ID
public static final java.lang.String LIST_PARAM_LIST_PAGE_SIZE
public static final java.lang.String LIST_PARAM_ORDER_CODE
public static final java.lang.String LIST_PARAM_ORDER_TYPE
public static final java.lang.String LIST_PARAM_CLIENT_ORDER_CODE
public static final java.lang.String LIST_PARAM_CLIENT_ORDER_TYPE
public static final java.lang.String LIST_PARAM_BEGIN_POSITION
public static final java.lang.String LIST_PARAM_END_POSITION
public static final java.lang.String LIST_PARAM_ACTUAL_PAGE
public static final java.lang.String LIST_PARAM_SHOW_COLUMN_CODES
public static final java.lang.String LIST_PARAM_FIRST_VISIBLE_ITEM
public static final java.lang.String LIST_PARAM_SELECTED_ITEMS
public static final java.lang.String LIST_PARAM_MARKED_ITEMS
public static final java.lang.String LIST_PARAM_IGNORED_ITEMS
public static final java.lang.String LIST_PARAM_LIST_PARENT_DATA_TYPE
public static final java.lang.String LIST_PARAM_LIST_PARENT_IDENTIFIER
public static final java.lang.String LIST_PARAM_KEEP_SELECTED
public static final java.lang.String LIST_PARAM_LIST_DOMAIN_ID
public static final java.lang.String LIST_PARAM_EXTRA_CONDITION_ATTRIBUTE
public static final java.lang.String LIST_PARAM_EXTRA_CONDITION_OPERATION
public static final java.lang.String LIST_PARAM_EXTRA_CONDITION_VALUE_TYPE
public static final java.lang.String LIST_PARAM_EXTRA_CONDITION_VALUE
protected java.lang.String m_strFactoryClassName
protected java.lang.Class m_clsFactory
| Constructor Detail |
|---|
public ListBrowserServlet()
| Method Detail |
|---|
public void init(javax.servlet.ServletConfig scConfig)
throws javax.servlet.ServletException
init in interface javax.servlet.Servletinit in class org.opensubsystems.core.www.WebUIServletjavax.servlet.ServletExceptionpublic java.lang.String getServletInfo()
getServletInfo in interface javax.servlet.ServletgetServletInfo in class org.opensubsystems.core.www.WebUIServlet
protected void doGet(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws javax.servlet.ServletException,
java.io.IOException
doGet in class javax.servlet.http.HttpServletjavax.servlet.ServletException
java.io.IOException
protected void doPost(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws javax.servlet.ServletException,
java.io.IOException
doPost in class javax.servlet.http.HttpServletjavax.servlet.ServletException
java.io.IOException
protected void processShowList(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws java.io.IOException,
javax.servlet.ServletException
hsrqRequest - - the servlet request.hsrpResponse - - the servlet response.
javax.servlet.ServletException - - an error while serving request
java.io.IOException - - an error while writing response
protected void processSetListFilter(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws java.io.IOException,
javax.servlet.ServletException
hsrqRequest - - the servlet request.hsrpResponse - - the servlet response.
javax.servlet.ServletException - - an error while serving request
java.io.IOException - - an error while writing response
protected void processSetOrder(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws java.io.IOException,
javax.servlet.ServletException
hsrqRequest - - the servlet request.hsrpResponse - - the servlet response.
javax.servlet.ServletException - - an error while serving request
java.io.IOException - - an error while writing response
protected void processSetPageSize(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws java.io.IOException,
javax.servlet.ServletException
hsrqRequest - - the servlet request.hsrpResponse - - the servlet response.
javax.servlet.ServletException - - an error while serving request
java.io.IOException - - an error while writing response
protected void processSetPrevPage(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws java.io.IOException,
javax.servlet.ServletException
hsrqRequest - - the servlet request.hsrpResponse - - the servlet response.
javax.servlet.ServletException - - an error while serving request
java.io.IOException - - an error while writing response
protected void processSetNextPage(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws java.io.IOException,
javax.servlet.ServletException
hsrqRequest - - the servlet request.hsrpResponse - - the servlet response.
javax.servlet.ServletException - - an error while serving request
java.io.IOException - - an error while writing response
protected void processSetExactPage(javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse)
throws java.io.IOException,
javax.servlet.ServletException
hsrqRequest - - the servlet request.hsrpResponse - - the servlet response.
javax.servlet.ServletException - - an error while serving request
java.io.IOException - - an error while writing responseprotected int getFormToProcess(javax.servlet.http.HttpServletRequest hsrqRequest)
getFormToProcess in class org.opensubsystems.core.www.WebUIServlet
protected ListOptions parseListFromRequest(javax.servlet.http.HttpServletRequest hsrqRequest,
int actionCode)
throws org.opensubsystems.core.error.OSSException
hsrqRequest - - HTTP request from HTML formactionCode - - code of submited action
org.opensubsystems.core.error.OSSException - - an error has occured while parsing request
protected void completeAction(java.lang.Object[] listInfo,
javax.servlet.http.HttpServletRequest hsrqRequest,
javax.servlet.http.HttpServletResponse hsrpResponse,
java.lang.String strUIID)
throws java.lang.Exception
listInfo - - returned list info {ListOption, List}hsrqRequest - - HTTP requesthsrpResponse - - HTTP responsstrUIID - - unique ID of the configuration parameter used to specify
UI to display. This is the same ID previously passed into
cacheUIPath method.
java.lang.Exception - - en error has accured
protected ListController getListController()
throws org.opensubsystems.core.error.OSSException
org.opensubsystems.core.error.OSSException - - an error has occured
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||