C D G I O P S T V

C

CheckPasswordExpiration(IPTSession, ApplicationData) - Method in class com.plumtree.portalpages.pei.PTLoginActions

This internal helper method checks if the password has expired or not.

com.plumtree.portalpages.pei - package com.plumtree.portalpages.pei

com.plumtree.portalpages.pei.util - package com.plumtree.portalpages.pei.util

com.plumtree.portaluiinfrastructure.pei - package com.plumtree.portaluiinfrastructure.pei

com.plumtree.portaluiinfrastructure.tags.pei - package com.plumtree.portaluiinfrastructure.tags.pei

com.plumtree.uiinfrastructure.pei - package com.plumtree.uiinfrastructure.pei

CustomizeQueryOnBeforeSearch(AActivitySpace, IPTSession, QueryArguments) - Method in interface com.plumtree.portalpages.pei.IAdvancedSearchActions

This function allows for the modification of the query portion of an advanced search.

CustomizeQueryOnBeforeSearch(AActivitySpace, IPTSession, QueryArguments) - Method in interface com.plumtree.portalpages.pei.IBannerSearchActions

This function allows for the modification of the query portion of a banner search.

D

DisplayJavascript(AActivitySpace) - Method in interface com.plumtree.uiinfrastructure.pei.IDisplayJavascriptActions

This method allows Javascript to be displayed in the script sections of many main pages, including Plumtree banner pages and editor pages.

G

GetBrowserLocaleSetting(AActivitySpace) - Static method in class com.plumtree.portalpages.pei.PTLoginActions

This method gets a supported locale from the browser settings, but does not set it anywhere.

GetCustomSettingsOnBeforeSearch(AActivitySpace, IPTSession) - Method in interface com.plumtree.portalpages.pei.IAdvancedSearchActions

This function allows for the modification of the settings used for an advanced search.

GetCustomSettingsOnBeforeSearch(AActivitySpace, IPTSession) - Method in interface com.plumtree.portalpages.pei.IBannerSearchActions

This function allows for the modification of the settings used for banner search.

I

IAdvancedSearchActions - Interface in com.plumtree.portalpages.pei

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 advanced search based event occurs.

IBannerSearchActions - Interface in com.plumtree.portalpages.pei

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 banner search based event occurs.

ICommunityActions - Interface in com.plumtree.portalpages.pei

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 community based event occurs.

ICreateAccountActions - Interface in com.plumtree.portalpages.pei

This interface was created to allow developers the ability to create functions that would be dynamically discovered by the Plumtree application that would perform some functionality that would occur during the acceptance of a invitation or manual creation of a user account.

IDirectoryActions - Interface in com.plumtree.portalpages.pei

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 directory based event occurs.

IDisplayJavascriptActions - Interface in com.plumtree.uiinfrastructure.pei

This class has been created to allow developers the ability to add some Javascript functionality to the script section on many main pages, such as Plumtree banner pages and editor pages.

ILoginActions - Interface in com.plumtree.uiinfrastructure.pei

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 login based event occurs.

ILoginActions2 - Interface in com.plumtree.uiinfrastructure.pei

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 login based event occurs.

IMyPortalPageActions - Interface in com.plumtree.portalpages.pei

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.

INetworkSearchActions - Interface in com.plumtree.portalpages.pei

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 network search based event occurs.

INewEditObjectActions - Interface in com.plumtree.portaluiinfrastructure.pei

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 object creation or modification based event occurs.

InternalGetBrowserLocale(String, IApplication, XPResourceManager) - Static method in class com.plumtree.portalpages.pei.PTLoginActions

This method gets a supported locale from the browser settings, and sets it on the http session and as a runtime setting.

InternalSetBrowserLocaleSetting(String, IPTSession, ISessionManager, ISessionManager, IApplication, XPResourceManager) - Static method in class com.plumtree.portalpages.pei.PTLoginActions

This method gets a supported locale from the browser settings, and sets it on the http session and as a runtime setting.

IObjectActions - Interface in com.plumtree.portalpages.pei

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 object management based event occurs.

IOpenerActions - Interface in com.plumtree.uiinfrastructure.pei

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 object creation or modification based event occurs.

IPageActions - Interface in com.plumtree.uiinfrastructure.pei

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.

IPasswordActions - Interface in com.plumtree.portalpages.pei

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 the user password is changed.

ISearchSettingActions - Interface in com.plumtree.portalpages.pei

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.

IUserProfileActions - Interface in com.plumtree.portalpages.pei

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.

O

OnAfterAcceptInvite(AActivitySpace, IPTSession, String) - Method in interface com.plumtree.portalpages.pei.ICreateAccountActions

This function will perform some functionality after a particular invitation has been accepted by a anonymous user.

OnAfterAcceptInvite(AActivitySpace, IPTSession, String) - Method in class com.plumtree.portalpages.pei.PTCreateAccountActions

OnAfterAddMyPortalPage(AActivitySpace, IPTSession, String, int) - Method in interface com.plumtree.portalpages.pei.IMyPortalPageActions

This function will perform some functionality after a new MyPage has been created.

OnAfterCreateABOJob(AActivitySpace, IPTSession, int, int, int) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality after an ABO Job is created to delete a Directory Object.

OnAfterCreateABOJob(AActivitySpace, IPTSession, int, int, int) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality after an ABO Job is created to delete an Object.

OnAfterCreateDirectoryFolder(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality after a Directory Folder has been created.

OnAfterDeleteDirectoryFolder(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality after a Directory Folder has been deleted.

OnAfterEditMyPortalPage(AActivitySpace, IPTSession, String, int) - Method in interface com.plumtree.portalpages.pei.IMyPortalPageActions

This function will perform some functionality after a MyPage has been edited.

OnAfterLogin(Object, ApplicationData) - Method in class com.plumtree.portalpages.pei.PTLoginActions

This function will take a given userSession and grab all of the users personal settings and take care of caching them.

OnAfterLogin(Object, ApplicationData) - Method in interface com.plumtree.uiinfrastructure.pei.ILoginActions

This function allows for some functionality to occur once the user has successfully logged in and then possibly do a redirect to someplace other than the MyPage.

OnAfterModifyOrRemoveSavedSearch(AActivitySpace, IPTSession, String[]) - Method in interface com.plumtree.portalpages.pei.ISearchSettingActions

This functions allows for some functionality to occur after the user has successfully modified or deleted saved searches.

OnAfterRemoveMyPortalPage(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IMyPortalPageActions

This function will perform some functionality after a user has deleted a page.

OnAfterSaveSearch(AActivitySpace, IPTSession, SavedSearchData) - Method in interface com.plumtree.portalpages.pei.ISearchSettingActions

This function allows for some functionality to occur after the user has saved a search.

OnAfterStoreObject(AActivitySpace, IPTSession, IPTObject) - Method in interface com.plumtree.portaluiinfrastructure.pei.INewEditObjectActions

This will perform some functionality just after the object has been stored in the database.

OnAfterUserJoinsCommunity(AActivitySpace, IPTSession, int[]) - Method in interface com.plumtree.portalpages.pei.ICommunityActions

This function can be used to notify after a user has directly joined a community.

OnAfterUserQuitsCommunity(AActivitySpace, IPTSession, int[]) - Method in interface com.plumtree.portalpages.pei.ICommunityActions

This function can be used to notify after a user has directly unsubscribed from a community.

OnBeforeAddMyPortalPage(AActivitySpace, IPTSession, String, int) - Method in interface com.plumtree.portalpages.pei.IMyPortalPageActions

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.

OnBeforeChangePassword(AActivitySpace, IPTSession, XPHashtable) - Method in interface com.plumtree.portalpages.pei.IPasswordActions

This interface will allow for the implementation of functions that will occur when a user tries to change their password.

OnBeforeChangePassword(AActivitySpace, IPTSession, XPHashtable) - Method in class com.plumtree.portalpages.pei.PTPasswordActions

OnBeforeChangeUserProfile(AActivitySpace, IPTSession, XPHashtable, XPHashtable) - Method in interface com.plumtree.portalpages.pei.IUserProfileActions

This functions was created to allow for some kind of verification of data to occur when a user tries to change their user profile.

OnBeforeCopyAdminFolder(AActivitySpace, IPTSession, int, int) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality before an Admin Folder is copied.

OnBeforeCopyObject(AActivitySpace, IPTSession, int, int, int) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality before an Object is copied from a folder to another.

OnBeforeCreateABOJob(AActivitySpace, IPTSession, int, int) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality before an ABO Job is created to delete a Directory Object.

OnBeforeCreateABOJob(AActivitySpace, IPTSession, int, int) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality before an ABO Job is created to delete an Object.

OnBeforeCreateAccount(AActivitySpace, IPTSession, String, String) - Method in interface com.plumtree.portalpages.pei.ICreateAccountActions

This function will perform some functionality after the manual creation of a user account.

OnBeforeCreateAccount(AActivitySpace, IPTSession, String, String) - Method in class com.plumtree.portalpages.pei.PTCreateAccountActions

OnBeforeCreateAdminFolder(AActivitySpace, IPTSession, String, String) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality before the creation process of a Admin Folder

OnBeforeCreateDirectoryFolder(AActivitySpace, IPTSession, String, String) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality before the creation process of a Directory Folder.

OnBeforeDeleteAdminFolder(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality before the deletion process of a Admin Folder.

OnBeforeDeleteDirectoryFolder(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality before the deletion process of a Directory Folder.

OnBeforeDeleteDocument(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality before the deletion process of a Document.

OnBeforeDeleteObject(AActivitySpace, IPTSession, int, int) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality before the deletion process of a set of objects.

OnBeforeEditMyPortalPage(AActivitySpace, IPTSession, String, int) - Method in interface com.plumtree.portalpages.pei.IMyPortalPageActions

This function will perform some validation based on the page name and page type when a user tries to edit a page.

OnBeforeLogin(ApplicationData, String) - Method in class com.plumtree.portalpages.pei.PTLoginActions

OnBeforeLogin(ApplicationData, String) - Method in interface com.plumtree.uiinfrastructure.pei.ILoginActions

This functions allows for some functionality to occur before the user has logged in to the Portal.

OnBeforeLogout(Object, ApplicationData) - Method in class com.plumtree.portalpages.pei.PTLoginActions

OnBeforeLogout(Object, ApplicationData) - Method in interface com.plumtree.uiinfrastructure.pei.ILoginActions

This function allows for some functionality to occur once the user has clicked on the Logoff link.

OnBeforeMigrateObject(AActivitySpace, IPTSession, int, int[]) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality during the Migration process of a set of objects.

OnBeforeMoveObject(AActivitySpace, IPTSession, int, int, int) - Method in interface com.plumtree.portalpages.pei.IObjectActions

This function will perform some functionality or validation before the move process of a object.

OnBeforeNetworkSearchProcess(AActivitySpace, IPTSession, String, IXPList) - Method in interface com.plumtree.portalpages.pei.INetworkSearchActions

This function will allow for some validation to occur against the search string being used and the list of sources being searched against.

OnBeforeOpen(int, int, String, XPHashtable, Redirect, AActivitySpace, Object) - Method in interface com.plumtree.uiinfrastructure.pei.IOpenerActions

This function will perform some functionality just before we use the Common Opener to open an object (or direct to an Activity Space).

OnBeforeRemoveMyPortalPage(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IMyPortalPageActions

This function will perform some functionality when a user tries to remove a page from their available listing of pages.

OnBeforeRemoveSavedSearch(AActivitySpace, IPTSession, SavedSearchData) - Method in interface com.plumtree.portalpages.pei.ISearchSettingActions

This functions allows for some functionality to occur before the user has successfully deleted a saved search.

OnBeforeSaveSearch(AActivitySpace, IPTSession, SavedSearchData) - Method in interface com.plumtree.portalpages.pei.ISearchSettingActions

This function allows for some functionality to occur before the user has saved a search.

OnBeforeStoreObject(AActivitySpace, IPTSession, IPTObject) - Method in interface com.plumtree.portaluiinfrastructure.pei.INewEditObjectActions

This will perform some functionality just before the object is stored to the database.

OnBeforeStoreUserProfile(AActivitySpace, IPTSession, XPHashtable) - Method in interface com.plumtree.portalpages.pei.IUserProfileActions

This functions was created to allow for some kind of verification of data to occur before a user tries to store their user profile.

OnClickThroughToDoc(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality during the click through of a particular document and then perform a Redirect or return Null.

OnCreateObject(AActivitySpace, IPTSession, int, int) - Method in interface com.plumtree.portaluiinfrastructure.pei.INewEditObjectActions

This function will perform some functionality just as we launch an Editor to create a new PTObject.

OnEditObject(AActivitySpace, IPTSession, int, int) - Method in interface com.plumtree.portaluiinfrastructure.pei.INewEditObjectActions

This function will perform some functionality just as we launch an Editor to edit and an existing PTObject.

OnFailedLogin(ApplicationData, String, XPException) - Method in class com.plumtree.portalpages.pei.PTLoginActions

OnFailedLogin(ApplicationData, String, XPException) - Method in interface com.plumtree.uiinfrastructure.pei.ILoginActions

This function allows for some functionality to occur if a user should not login successfully.

OnFailedLoginDoRedirect(ApplicationData, String, XPException) - Method in interface com.plumtree.uiinfrastructure.pei.ILoginActions2

This function allows for some functionality to occur if a user should not login successfully and then possibly do a redirect to someplace other than the standard Login page.

OnOpenFolder(AActivitySpace, IPTSession, int) - Method in interface com.plumtree.portalpages.pei.IDirectoryActions

This function will perform some functionality during the Opening of a folder within the directory structure and then perform a Redirect or return Null.

OnPageFinish(AActivitySpace, Object, String) - Method in class com.plumtree.portalpages.pei.ProfileViewActions

OnPageFinish(AActivitySpace, Object, String) - Method in class com.plumtree.portaluiinfrastructure.tags.pei.TagPageActions

OnPageFinish(AActivitySpace, Object, String) - Method in interface com.plumtree.uiinfrastructure.pei.IPageActions

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

OnPageStart(AActivitySpace, Object, String) - Method in class com.plumtree.portalpages.pei.ProfileViewActions

OnPageStart(AActivitySpace, Object, String) - Method in class com.plumtree.portaluiinfrastructure.tags.pei.TagPageActions

OnPageStart(AActivitySpace, Object, String) - Method in interface com.plumtree.uiinfrastructure.pei.IPageActions

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

P

PASSWORD_LAST_CHANGED - Static variable in class com.plumtree.portalpages.pei.PTLoginActions

PasswordValidator - Class in com.plumtree.portalpages.pei.util

This helper class handles password validation for native users.

PasswordValidator() - Constructor for class com.plumtree.portalpages.pei.util.PasswordValidator

ProfileViewActions - Class in com.plumtree.portalpages.pei

ProfileViewActions() - Constructor for class com.plumtree.portalpages.pei.ProfileViewActions

PTCreateAccountActions - Class in com.plumtree.portalpages.pei

This class handles validating new passwords for native users.

PTCreateAccountActions() - Constructor for class com.plumtree.portalpages.pei.PTCreateAccountActions

PTLoginActions - Class in com.plumtree.portalpages.pei

PTLoginActions() - Constructor for class com.plumtree.portalpages.pei.PTLoginActions

PTPasswordActions - Class in com.plumtree.portalpages.pei

This class handles validating changed passwords for native users.

PTPasswordActions() - Constructor for class com.plumtree.portalpages.pei.PTPasswordActions

S

SetBrowserLocaleSetting(ApplicationData, IPTSession, ISessionManager, ISessionManager, IApplication, XPResourceManager) - Method in class com.plumtree.portalpages.pei.PTLoginActions

This method gets a supported locale from the browser settings, and sets it on the http session and as a runtime setting.

T

TagPageActions - Class in com.plumtree.portaluiinfrastructure.tags.pei

This PEI resets the tag page request data at the end of every HTTP request.

TagPageActions() - Constructor for class com.plumtree.portaluiinfrastructure.tags.pei.TagPageActions

V

ValidatePassword(String, String, AActivitySpace, OpenLogger) - Method in class com.plumtree.portalpages.pei.util.PasswordValidator

Validate that the new password complies with the password management rules.

C D G I O P S T V