001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Portal/Sources/es/udc/mypersonalizer/portal/conventions/RequestParameterConventions.java,v 1.1.1.1 2004/03/25 12:08:41 fbellas Exp $
003: * $Revision: 1.1.1.1 $
004: * $Date: 2004/03/25 12:08:41 $
005: *
006: * =============================================================================
007: *
008: * Copyright (c) 2003, The MyPersonalizer Development Group
009: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
010: * University Of A Coruna
011: * All rights reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions are met:
015: *
016: * - Redistributions of source code must retain the above copyright notice,
017: * this list of conditions and the following disclaimer.
018: *
019: * - Redistributions in binary form must reproduce the above copyright notice,
020: * this list of conditions and the following disclaimer in the documentation
021: * and/or other materials provided with the distribution.
022: *
023: * - Neither the name of the University Of A Coruna nor the names of its
024: * contributors may be used to endorse or promote products derived from
025: * this software without specific prior written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
028: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
029: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
030: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
031: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
032: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
033: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
034: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
035: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
036: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
037: * POSSIBILITY OF SUCH DAMAGE.
038: *
039: */
040:
041: package es.udc.mypersonalizer.portal.conventions;
042:
043: import es.udc.mypersonalizer.kernel.model.editors.UserRegistrationInformationEditor;
044:
045: /**
046: * Defines conventions for HTTP request parameters.
047: *
048: * @author Fernando Bellas
049: * @since 1.0
050: */
051: public class RequestParameterConventions {
052:
053: /**
054: * Parameter name specifying workspace identifier.
055: */
056: public static final String WORKSPACE_IDENTIFIER = "workspaceIdentifier";
057:
058: /**
059: * Parameter name specifying a service identifier.
060: */
061: public static final String SERVICE_IDENTIFIER = "serviceIdentifier";
062:
063: /**
064: * Multi-valued parameter name specifying a list of service identifiers.
065: */
066: public static final String SERVICE_IDENTIFIERS = "serviceIdentifiers";
067:
068: /**
069: * Parameter specifying the property updater
070: * (see @link es.udc.mypersonalizer.portal.model.wizards.PropertyUpdater)
071: * to use in a wizard.
072: */
073: public static final String PROPERTY_UPDATER_NAME = "propertyUpdaterName";
074:
075: /**
076: * A relative name to a root compound property, specifying a particular
077: * <code>PropertyStructure</code>. For the saved searches service example
078: * provided in the documentation of
079: * {@link es.udc.mypersonalizer.kernel.model.properties.Property}
080: * "1" is a property structure name, specifying the second (remember
081: * indexes are numbered from 0 upwards) property structure of
082: * the values of the root property ("savedSearches"). In a more complex
083: * example, "2.a.3" will be a property stucture name
084: * specifying the fourth property structure of the compound
085: * property "a", inserted in the third property structure of the root
086: * property. Note that property structure names always start and finish
087: * with indexes.
088: */
089: public static final String PROPERTY_STRUCTURE_NAME = "propertyStructureName";
090:
091: /**
092: * Parameter specifying the previous values (separated by ",")
093: * of the parameter <code>PROPERTY_STRUCTURE_NAME</code> in a multi-step
094: * wizard.
095: */
096: public static final String PREVIOUS_PROPERTY_STRUCTURE_NAMES = "previousPropertyStructureNames";
097:
098: /**
099: * Multi-valued parameter name specifying simple property names
100: * relative to a property structure name. That is, a property structure
101: * name concatenated with a simple property name must specify a simple
102: * property name from the root property. Example: for the news service
103: * example presented in {@link #PROPERTY_STRUCTURE_NAME}, and considering
104: * "1" as a property structure name, "keywords" is a valid simple property
105: * name if "1.keywords" names an existing simple property from the
106: * root property. In a more complex example, and considering "2.a.3"
107: * as a property structure name, "c.0.d" is a valid simple property
108: * name if "2.a.3.c.0.d" names an existing simple property from the root
109: * property.
110: */
111: public static final String SIMPLE_PROPERTY_NAMES = "simplePropertyNames";
112:
113: /**
114: * Multi-valued parameter name specifying simple property names not to be
115: * trimmed.
116: */
117: public static final String SIMPLE_PROPERTY_NAMES_NOT_TO_TRIM = "simplePropertyNamesNotToTrim";
118:
119: /**
120: * Parameter name specifying a property identifier.
121: */
122: public static final String PROPERTY_IDENTIFIER = "propertyIdentifier";
123:
124: /**
125: * Parameter name specifying a login name.
126: */
127: public static final String LOGIN_NAME = UserRegistrationInformationEditor.LOGIN_NAME;
128:
129: /**
130: * Parameter name specifying a password.
131: */
132: public static final String PASSWORD = UserRegistrationInformationEditor.PASSWORD;
133:
134: /**
135: * Parameter name specifying an old password.
136: */
137: public static final String OLD_PASSWORD = "oldPassword";
138:
139: /**
140: * Parameter name specifying a retyped password.
141: */
142: public static final String RETYPED_PASSWORD = "retypedPassword";
143:
144: /**
145: * Parameter name specifying whether or not the option "Remember my
146: * password" has been selected.
147: */
148: public static final String REMEMBER_PASSWORD = "rememberPassword";
149:
150: /**
151: * Parameter name identifying a service buttons state identifier.
152: */
153: public static final String SERVICE_BUTTONS_STATE_IDENTIFIER = "serviceButtonsStateIdentifier";
154:
155: /**
156: * Parameter name identifying the name of a button
157: */
158: public static final String BUTTON_NAME = "buttonName";
159:
160: /**
161: * Parameter name identifying the state to which a button will
162: * be switched.
163: */
164: public static final String BUTTON_STATE = "buttonState";
165:
166: /**
167: * This parameter identifies the workspace name, and is used when
168: * the user is given the possibility to change it.
169: */
170: public final static String WORKSPACE_NAME = "workspaceName";
171:
172: /**
173: * This parameter identifies the workspace type or identifier, for
174: * adding a new workspace.
175: */
176: public final static String WORKSPACE = "workspace";
177:
178: /**
179: * This parameter identifies a list of workspace layout identifiers.
180: */
181: public final static String WORKSPACE_LAYOUT_IDENTIFIERS = "workspaceLayoutIdentifiers";
182:
183: /**
184: * Disallows creation of instances.
185: */
186: private RequestParameterConventions() {
187: }
188:
189: }
|