com.plumtree.portalpages.pei
Interface IMyPortalPageActions


public interface IMyPortalPageActions

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 mypage 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: Be careful if implementing this interface more than once, as there could be very significant problems if multiple functions are making changes to the same page name or page type.

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
 void OnAfterAddMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strPageName, int _nPageTypeID)
          This function will perform some functionality after a new MyPage has been created.
 void OnAfterEditMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strPageName, int _nPageTypeID)
          This function will perform some functionality after a MyPage has been edited.
 void OnAfterRemoveMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nPageID)
          This function will perform some functionality after a user has deleted a page.
 MyPortalPageArguments OnBeforeAddMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strPageName, int _nPageTypeID)
          This function will perform some validation based on the page name and page type when a user tries to add a new page to their available listing of pages.
 MyPortalPageArguments OnBeforeEditMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strPageName, int _nPageTypeID)
          This function will perform some validation based on the page name and page type when a user tries to edit a page.
 java.lang.String OnBeforeRemoveMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nPageID)
          This function will perform some functionality when a user tries to remove a page from their available listing of pages.
 

Method Detail

OnAfterAddMyPortalPage

void OnAfterAddMyPortalPage(AActivitySpace _asCurrentSpace,
                            IPTSession _ptUserSession,
                            java.lang.String _strPageName,
                            int _nPageTypeID)
This function will perform some functionality after a new MyPage has been created.

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
_strPageName - - Name of the new MyPage
_nPageTypeID - - Type of the new MyPage

OnAfterEditMyPortalPage

void OnAfterEditMyPortalPage(AActivitySpace _asCurrentSpace,
                             IPTSession _ptUserSession,
                             java.lang.String _strPageName,
                             int _nPageTypeID)
This function will perform some functionality after a MyPage has been edited.

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
_strPageName - - Name of the MyPortal Page.
_nPageTypeID - - Page Type of the MyPortal page.

OnAfterRemoveMyPortalPage

void OnAfterRemoveMyPortalPage(AActivitySpace _asCurrentSpace,
                               IPTSession _ptUserSession,
                               int _nPageID)
This function will perform some functionality after a user has deleted a page.

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
_nPageID - - ID of the MyPage that the user has removed.

OnBeforeAddMyPortalPage

MyPortalPageArguments OnBeforeAddMyPortalPage(AActivitySpace _asCurrentSpace,
                                              IPTSession _ptUserSession,
                                              java.lang.String _strPageName,
                                              int _nPageTypeID)
This function will perform some validation based on the page name and page type when a user tries to add a new page to their available listing of pages.

NOTE: The int item of the MyPortalPageArguments needs to be a valid PageTypeConstant or there will be errors when processed.

NOTE: The String item of the MyPortalPageArguments needs to be non-null and with a length greater than 0 but less than or equal to 20. Otherwise the original _strPageName will superscede this value.

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
_strPageName - - Name that the user is trying to assign to this new MyPortal Page.
_nPageTypeID - - Page Type that the user wants to use for the new MyPortal page.
Returns:
MyPortalPageArguments - This object will contain a String pertaining to the modified name being returned and a int pertaining to the modified page layout.

OnBeforeEditMyPortalPage

MyPortalPageArguments OnBeforeEditMyPortalPage(AActivitySpace _asCurrentSpace,
                                               IPTSession _ptUserSession,
                                               java.lang.String _strPageName,
                                               int _nPageTypeID)
This function will perform some validation based on the page name and page type when a user tries to edit a page.

NOTE: The int item of the MyPortalPageArguments needs to be a valid PageTypeConstant or there will be errors when processed.

NOTE: The String item of the MyPortalPageArguments needs to be non-null and with a length greater than 0 but less than or equal to 20. Otherwise the original _strPageName will superscede this value.

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
_strPageName - - Name that the user is trying to assign to this MyPortal Page.
_nPageTypeID - - Page Type that the user wants to use for the MyPortal page.
Returns:
MyPortalPageArguments - This object will contain a String pertaining to the modified name being returned and a int pertaining to the modified page layout.

OnBeforeRemoveMyPortalPage

java.lang.String OnBeforeRemoveMyPortalPage(AActivitySpace _asCurrentSpace,
                                            IPTSession _ptUserSession,
                                            int _nPageID)
This function will perform some functionality when a user tries to remove a page from their available listing of pages.

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
_nPageID - - Page ID that the user is trying to remove.
Returns:
String - Error message if the deletion should not continue, empty string or null if it should.



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