com.plumtree.portalpages.pei
Interface IUserProfileActions

public interface IUserProfileActions

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 a particular user profile based event occurs.

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	OnBeforeChangeUserProfile(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, XPHashtable _htFormData, XPHashtable _htPropObjs) This functions was created to allow for some kind of verification of data to occur when a user tries to change their user profile.
java.lang.String	OnBeforeStoreUserProfile(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, XPHashtable _htPropObjs) This functions was created to allow for some kind of verification of data to occur before a user tries to store their user profile.

Method Detail

OnBeforeChangeUserProfile

java.lang.String OnBeforeChangeUserProfile(AActivitySpace _asCurrentSpace,
                                           IPTSession _ptUserSession,
                                           XPHashtable _htFormData,
                                           XPHashtable _htPropObjs)

This functions was created to allow for some kind of verification of data to occur when a user tries to change their user profile. It gets called every time the editor attempts to save a page.

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 referes to all of the data that the user is dealing with. It would correspond to each piece of the User Profile View.

_htPropObjs - - This parameter is a hashtable containing all of the necessary Property data, using the html input name as the key. With the Property object, information such as the id, name, and type can be retrieved.

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 "".

OnBeforeStoreUserProfile

java.lang.String OnBeforeStoreUserProfile(AActivitySpace _asCurrentSpace,
                                          IPTSession _ptUserSession,
                                          XPHashtable _htPropObjs)

This functions was created to allow for some kind of verification of data to occur before a user tries to store their user profile. It gets called every time the editor is finished.

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

_htPropObjs - - This parameter is a hashtable containing all of the necessary Property data, using the Property ID as the key. With the Property object, information such as the id, name, and type can be retrieved.

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 "".