|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
void OnAfterAddMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strPageName, int _nPageTypeID)
_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 MyPagevoid OnAfterEditMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strPageName, int _nPageTypeID)
_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.void OnAfterRemoveMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nPageID)
_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.MyPortalPageArguments OnBeforeAddMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strPageName, int _nPageTypeID)
_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.
MyPortalPageArguments OnBeforeEditMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strPageName, int _nPageTypeID)
_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.
java.lang.String OnBeforeRemoveMyPortalPage(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nPageID)
_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.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |