com.plumtree.uiinfrastructure.pei
Interface IPageActions

All Known Implementing Classes:

ProfileViewActions, TagPageActions

public interface IPageActions

This class has been created to allow developers the ability to add some functionality to the beginning and end of any and every page that is displayed within the Plumtree Portal. The amount of functionality that is available is going to be and should be extremely limited as this could affect performance a great deal.

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: These functions will primarily be implemented within the cases of a MyPortal Page, Community Page, Directory Page, and Login Page. As these pages all include Gateway requests, we will not be worrying about Gateway requests, just the outer containers request.

NOTE: All information needed to use as a key for timestamps should be available from the Server Name and Activity Space, such as User ID, Activity Space Name, current Display Page Name and so on. There is also a possibility that the _oUserSession passed in to OnPageStart() and OnPageFinish() will be different (such as when you click finish after editing the mypage layout - the request will start in the edit layout space, but finish in the myPage space).

Method Summary

HTMLComment	OnPageFinish(AActivitySpace _asCurrentSpace, java.lang.Object _oUserSession, java.lang.String _strServerName) This function allows for some functionality to be created at the very end of the processing of the page.
void	OnPageStart(AActivitySpace _asCurrentSpace, java.lang.Object _oUserSession, java.lang.String _strServerName) This function allows for some functionality to be created at the very beginning of the page.

Method Detail

OnPageFinish

HTMLComment OnPageFinish(AActivitySpace _asCurrentSpace,
                         java.lang.Object _oUserSession,
                         java.lang.String _strServerName)

This function allows for some functionality to be created at the very end of the processing of the page.

Parameters:

_asCurrentSpace - - Provides access to the current MVC classes as well as the Application and the HTTP Session

_oUserSession - - Session object for the current user

_strServerName - - Server from which the page request originated.

Returns:

HTMLComment - The return object will be a HTMLComment that will be added to the end of the page being displayed. If no information is needed to be returned, then just return Null.

OnPageStart

void OnPageStart(AActivitySpace _asCurrentSpace,
                 java.lang.Object _oUserSession,
                 java.lang.String _strServerName)

This function allows for some functionality to be created at the very beginning of the page.

Parameters:

_asCurrentSpace - - Provides access to the current MVC classes as well as the Application and the HTTP Session

_oUserSession - - Session object for the current user

_strServerName - - Server from which the page request began.