com.plumtree.portalpages.pei
Interface ISearchSettingActions


public interface ISearchSettingActions

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 search setting 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.


Method Summary
 void OnAfterModifyOrRemoveSavedSearch(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String[] _arrCurrentSavedSearches)
          This functions allows for some functionality to occur after the user has successfully modified or deleted saved searches.
 void OnAfterSaveSearch(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, SavedSearchData _searchData)
          This function allows for some functionality to occur after the user has saved a search.
 void OnBeforeRemoveSavedSearch(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, SavedSearchData _searchData)
          This functions allows for some functionality to occur before the user has successfully deleted a saved search.
 void OnBeforeSaveSearch(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, SavedSearchData _searchData)
          This function allows for some functionality to occur before the user has saved a search.
 

Method Detail

OnAfterModifyOrRemoveSavedSearch

void OnAfterModifyOrRemoveSavedSearch(AActivitySpace _asCurrentSpace,
                                      IPTSession _ptUserSession,
                                      java.lang.String[] _arrCurrentSavedSearches)
This functions allows for some functionality to occur after the user has successfully modified or deleted saved searches.

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
_arrCurrentSavedSearches - - Array of current saved search names (after modifying and/or deleting them)

OnAfterSaveSearch

void OnAfterSaveSearch(AActivitySpace _asCurrentSpace,
                       IPTSession _ptUserSession,
                       SavedSearchData _searchData)
This function allows for some functionality to occur after the user has saved a search.

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
_searchData - - This is an instance of the SavedSearchData class, which provides access to the data associated with the saved search.

OnBeforeRemoveSavedSearch

void OnBeforeRemoveSavedSearch(AActivitySpace _asCurrentSpace,
                               IPTSession _ptUserSession,
                               SavedSearchData _searchData)
This functions allows for some functionality to occur before the user has successfully deleted a saved search.

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
_searchData - - This is an instance of the SavedSearchData class, which provides access to the data associated with the saved search. Changes to the data are ignored.

OnBeforeSaveSearch

void OnBeforeSaveSearch(AActivitySpace _asCurrentSpace,
                        IPTSession _ptUserSession,
                        SavedSearchData _searchData)
This function allows for some functionality to occur before the user has saved a search.

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
_searchData - - This is an instance of the SavedSearchData class, which provides access to the data associated with the saved search.



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