com.plumtree.portalpages.pei
Interface IPasswordActions

All Known Implementing Classes:
PTPasswordActions

public interface IPasswordActions

This interface was created to allow developers the ability to create functions that can be dynamically discovered by the Plumtree application for the purposes of performing some functionality when the user password is changed.

NOTE: Should this interface be implemented more than once within the Dynamic Discovery process, the implementations will be processed in the order that they are displayed within the representative XML file. All implementations will be called.

NOTE: In the case where multiple implementations return a String object, all the valid Strings (not null and not empty) will be appended together (separated by a blank space) and the final String will be the error message displayed on the page.


Method Summary
 java.lang.String OnBeforeChangePassword(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, XPHashtable _htFormData)
          This interface will allow for the implementation of functions that will occur when a user tries to change their password.
 

Method Detail

OnBeforeChangePassword

java.lang.String OnBeforeChangePassword(AActivitySpace _asCurrentSpace,
                                        IPTSession _ptUserSession,
                                        XPHashtable _htFormData)
This interface will allow for the implementation of functions that will occur when a user tries to change their password.

Warning: Values in _htFormData are String Arrays (String[]).
e.g.:
String[] arrVals = (String[]) _htFormData.GetElement(sKey);
String sVal = arrVals[0];

Parameters:
_asCurrentSpace - - Provides access to the current MVC classes as well as the Application and the HTTP Session
_ptUserSession - - Plumtree session object for the current user
_htFormData - - This parameter refers to the form data that has been entered by the user during the changing of a password.
Returns:
String - This will be a string containing a error message if the data was incorrect or if the process should not continue otherwise it will be null or "".



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.