/*
* $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 $
* $Revision: 1.1.1.1 $
* $Date: 2004/03/25 12:08:41 $
*
* =============================================================================
*
* Copyright (c) 2003, The MyPersonalizer Development Group
* (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
* University Of A Coruna
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* - Neither the name of the University Of A Coruna nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*/
package es.udc.mypersonalizer.portal.conventions;
import es.udc.mypersonalizer.kernel.model.editors.
UserRegistrationInformationEditor;
/**
* Defines conventions for HTTP request parameters.
*
* @author Fernando Bellas
* @since 1.0
*/
public class RequestParameterConventions {
/**
* Parameter name specifying workspace identifier.
*/
public static final String WORKSPACE_IDENTIFIER = "workspaceIdentifier";
/**
* Parameter name specifying a service identifier.
*/
public static final String SERVICE_IDENTIFIER = "serviceIdentifier";
/**
* Multi-valued parameter name specifying a list of service identifiers.
*/
public static final String SERVICE_IDENTIFIERS = "serviceIdentifiers";
/**
* Parameter specifying the property updater
* (see @link es.udc.mypersonalizer.portal.model.wizards.PropertyUpdater)
* to use in a wizard.
*/
public static final String PROPERTY_UPDATER_NAME = "propertyUpdaterName";
/**
* A relative name to a root compound property, specifying a particular
* <code>PropertyStructure</code>. For the saved searches service example
* provided in the documentation of
* {@link es.udc.mypersonalizer.kernel.model.properties.Property}
* "1" is a property structure name, specifying the second (remember
* indexes are numbered from 0 upwards) property structure of
* the values of the root property ("savedSearches"). In a more complex
* example, "2.a.3" will be a property stucture name
* specifying the fourth property structure of the compound
* property "a", inserted in the third property structure of the root
* property. Note that property structure names always start and finish
* with indexes.
*/
public static final String PROPERTY_STRUCTURE_NAME =
"propertyStructureName";
/**
* Parameter specifying the previous values (separated by ",")
* of the parameter <code>PROPERTY_STRUCTURE_NAME</code> in a multi-step
* wizard.
*/
public static final String PREVIOUS_PROPERTY_STRUCTURE_NAMES =
"previousPropertyStructureNames";
/**
* Multi-valued parameter name specifying simple property names
* relative to a property structure name. That is, a property structure
* name concatenated with a simple property name must specify a simple
* property name from the root property. Example: for the news service
* example presented in {@link #PROPERTY_STRUCTURE_NAME}, and considering
* "1" as a property structure name, "keywords" is a valid simple property
* name if "1.keywords" names an existing simple property from the
* root property. In a more complex example, and considering "2.a.3"
* as a property structure name, "c.0.d" is a valid simple property
* name if "2.a.3.c.0.d" names an existing simple property from the root
* property.
*/
public static final String SIMPLE_PROPERTY_NAMES = "simplePropertyNames";
/**
* Multi-valued parameter name specifying simple property names not to be
* trimmed.
*/
public static final String SIMPLE_PROPERTY_NAMES_NOT_TO_TRIM =
"simplePropertyNamesNotToTrim";
/**
* Parameter name specifying a property identifier.
*/
public static final String PROPERTY_IDENTIFIER = "propertyIdentifier";
/**
* Parameter name specifying a login name.
*/
public static final String LOGIN_NAME =
UserRegistrationInformationEditor.LOGIN_NAME;
/**
* Parameter name specifying a password.
*/
public static final String PASSWORD =
UserRegistrationInformationEditor.PASSWORD;
/**
* Parameter name specifying an old password.
*/
public static final String OLD_PASSWORD = "oldPassword";
/**
* Parameter name specifying a retyped password.
*/
public static final String RETYPED_PASSWORD = "retypedPassword";
/**
* Parameter name specifying whether or not the option "Remember my
* password" has been selected.
*/
public static final String REMEMBER_PASSWORD = "rememberPassword";
/**
* Parameter name identifying a service buttons state identifier.
*/
public static final String SERVICE_BUTTONS_STATE_IDENTIFIER =
"serviceButtonsStateIdentifier";
/**
* Parameter name identifying the name of a button
*/
public static final String BUTTON_NAME = "buttonName";
/**
* Parameter name identifying the state to which a button will
* be switched.
*/
public static final String BUTTON_STATE = "buttonState";
/**
* This parameter identifies the workspace name, and is used when
* the user is given the possibility to change it.
*/
public final static String WORKSPACE_NAME = "workspaceName";
/**
* This parameter identifies the workspace type or identifier, for
* adding a new workspace.
*/
public final static String WORKSPACE = "workspace";
/**
* This parameter identifies a list of workspace layout identifiers.
*/
public final static String WORKSPACE_LAYOUT_IDENTIFIERS =
"workspaceLayoutIdentifiers";
/**
* Disallows creation of instances.
*/
private RequestParameterConventions () {}
}
|