001/**
002 * Copyright 2005-2014 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.uif;
017
018/**
019 * Constants for parameter names that need to be retrieved from general
020 * <code>Map</code> implementations (like the request, action parameters map,
021 * component template options, component layout options)
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public class UifParameters {
026
027    public static final String AJAX_REQUEST = "ajaxRequest";
028    public static final String AJAX_RETURN_TYPE = "ajaxReturnType";
029        public static final String AUTO_SEARCH = "autoSearch";
030        public static final String BASE_LOOKUP_URL = "baseLookupUrl";
031        public static final String METHOD_TO_CALL = "methodToCall";
032    public static final String CLIENT_VIEW_STATE = "clientViewState";
033    public static final String CONVERSION_FIELDS = "conversionFields";
034    public static final String CONFIG_PROPERTIES = "ConfigProperties";
035        public static final String DATA_OBJECT_CLASS_NAME = "dataObjectClassName";
036        public static final String RENDER_CRITERIA_ACTIONS = "renderCriteriaActions";
037    public static final String DOCUMENT_CLASS = "documentClass";
038    public static final String DOC_NUM = "docNum";
039    public static final String DOC_TYPE_NAME = "docTypeName";
040    public static final String FORMAT_TYPE = "formatType";
041    public static final String FORM_KEY = "formKey";
042    public static final String FORM_MANAGER = "formManager";
043        public static final String RENDER_RETURN_LINK = "renderReturnLink";
044    public static final String HIDE_CRITERIA_ON_SEARCH = "hideCriteriaOnSearch";
045    public static final String JUMP_TO_ID = "jumpToId";
046    public static final String FOCUS_ID = "focusId";
047        public static final String RENDER_LOOKUP_CRITERIA = "renderlookupCriteria";
048    public static final String LABEL = "label";
049        public static final String LOOKUP_PARAMETERS = "lookupParameters";
050    public static final String LOOKUP_COLLECTION_NAME = "lookupCollectionName";
051    public static final String LOOKUP_COLLECTION_ID = "lookupCollectionId";
052    public static final String MULTIPLE_VALUES_SELECT = "multipleValuesSelect";
053        public static final String READ_ONLY_FIELDS = "readOnlyFields";
054    public static final String REDIRECTED_INQUIRY = "redirectedInquiry";
055    public static final String REDIRECTED_LOOKUP = "redirectedLookup";
056        public static final String REFERENCES_TO_REFRESH = "referencesToRefresh";
057    public static final String REFRESH_STATUS = "refreshStatus";
058    public static final String RENDER_HELPER_METHODS = "HelperMethods";
059    public static final String RETURN_BY_SCRIPT = "returnByScript";
060        public static final String RETURN_LOCATION = "returnLocation";
061        public static final String RETURN_FORM_KEY = "returnFormKey";
062    public static final String RETURN_FROM_DIALOG = "returnFromDialog";
063    public static final String REQUESTED_COMPONENT_ID = "reqComponentId";
064    public static final String REQUEST = "request";
065    public static final String SHOW_INACTIVE_RECORDS = "showInactiveRecords";
066        public static final String SELECTED_COLLECTION_PATH = "selectedCollectionPath";
067    public static final String SELECTED_COLLECTION_ID = "selectedCollectionId";
068        public static final String SELECTED_LINE_INDEX = "selectedLineIndex";
069    public static final String SELECTED_LINE_VALUES = "selectedLineValues";
070    public static final String MULIT_VALUE_RETURN_FILEDS = "multiValueReturnFields";
071    public static final String SESSION_ID = "sessionId";
072        public static final String RENDER_MAINTENANCE_LINKS = "renderMaintenanceLinks";
073        public static final String RENDER_RESULT_ACTIONS = "renderResultActions";
074        public static final String PAGE_ID = "pageId";
075        public static final String NAVIGATE_TO_PAGE_ID = "navigateToPageId";
076    public static final String VALUE = "value";
077    public static final String VIEW = "view";
078        public static final String VIEW_ID = "viewId";
079        public static final String VIEW_NAME = "viewName";
080        public static final String VIEW_TYPE_NAME = "viewTypeName";
081        public static final String ACTION_TYPE = "actionType";
082        public static final String ADD_LINE = "addLine";
083    public static final String QUERY_PARAMETER = "queryParameters";
084    public static final String QUERY_FIELD_ID = "queryFieldId";
085    public static final String QUERY_TERM = "queryTerm";
086    public static final String QUICKFINDER_ID = "quickfinderId";
087    public static final String UPDATE_COMPONENT_ID = "updateComponentId";
088    public static final String REQUESTED_FORM_KEY = "requestedFormKey";
089    public static final String MESSAGE_TO_DISPLAY = "messageToDisplay";
090
091    public static class Attributes {
092        public static final String VIEW_LIFECYCLE_COMPLETE = "ViewLifecycleComplete";
093    }
094}