com.plumtree.portalpages.pei
Interface IDirectoryActions


public interface IDirectoryActions

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.

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: In the case where a Redirect object is returned, the first implementation of the interface that actually returns a valid Redirect will be the one that will be processed.

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 OnAfterCreateABOJob(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nJobID, int _nClassID, int _nObjectID)
          This function will perform some functionality after an ABO Job is created to delete a Directory Object.
 void OnAfterCreateDirectoryFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nFolderID)
          This function will perform some functionality after a Directory Folder has been created.
 void OnAfterDeleteDirectoryFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nFolderID)
          This function will perform some functionality after a Directory Folder has been deleted.
 java.lang.String OnBeforeCreateABOJob(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nClassID, int _nObjectID)
          This function will perform some functionality before an ABO Job is created to delete a Directory Object.
 java.lang.String OnBeforeCreateDirectoryFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strFolderName, java.lang.String _strFolderDescription)
          This function will perform some functionality before the creation process of a Directory Folder.
 java.lang.String OnBeforeDeleteDirectoryFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nFolderID)
          This function will perform some functionality before the deletion process of a Directory Folder.
 java.lang.String OnBeforeDeleteDocument(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nDocumentID)
          This function will perform some functionality before the deletion process of a Document.
 Redirect OnClickThroughToDoc(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nDocumentID)
          This function will perform some functionality during the click through of a particular document and then perform a Redirect or return Null.
 Redirect OnOpenFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nFolderID)
          This function will perform some functionality during the Opening of a folder within the directory structure and then perform a Redirect or return Null.
 

Method Detail

OnAfterCreateABOJob

void OnAfterCreateABOJob(AActivitySpace _asCurrentSpace,
                         IPTSession _ptUserSession,
                         int _nJobID,
                         int _nClassID,
                         int _nObjectID)
This function will perform some functionality after an ABO Job is created to delete a Directory Object.

More info on ABO Jobs and when this PEI is called:
When the user deletes an Directory Folder, since this action might require a lot of processing time, he will have the choice between deleting the folder now or scheduling an ABO Job to do it later and minimize the impact on the Portal's performance. If he decides to do it now, the OnDeleteDirectoryFolder PEI is called, if he decides to have it done later by a Job, the OnBeforeCreateABOJob and OnAfterCreateABOJob PEIs are called.

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
_nJobID - - ID of the ABO Job created
_nClassID - - Class ID of the Object that the Job will delete
_nObjectID - - ID of the Object that the Job will delete

OnAfterCreateDirectoryFolder

void OnAfterCreateDirectoryFolder(AActivitySpace _asCurrentSpace,
                                  IPTSession _ptUserSession,
                                  int _nFolderID)
This function will perform some functionality after a Directory Folder 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
_nFolderID - - The specific folder being created

OnAfterDeleteDirectoryFolder

void OnAfterDeleteDirectoryFolder(AActivitySpace _asCurrentSpace,
                                  IPTSession _ptUserSession,
                                  int _nFolderID)
This function will perform some functionality after a Directory Folder has been deleted.

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
_nFolderID - - The specific folder being deleted

OnBeforeCreateABOJob

java.lang.String OnBeforeCreateABOJob(AActivitySpace _asCurrentSpace,
                                      IPTSession _ptUserSession,
                                      int _nClassID,
                                      int _nObjectID)
This function will perform some functionality before an ABO Job is created to delete a Directory Object.

More info on ABO Jobs and when this PEI is called:
When the user deletes an Directory Folder, since this action might require a lot of processing time, he will have the choice between deleting the folder now or scheduling an ABO Job to do it later and minimize the impact on the Portal's performance. If he decides to do it now, the OnDeleteDirectoryFolder PEI is called, if he decides to have it done later by a Job, the OnBeforeCreateABOJob and OnAfterCreateABOJob PEIs are called.

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
_nClassID - - Class ID of the Object that the Job will delete
_nObjectID - - ID of the Object that the Job will delete
Returns:
String - Error message if the creation of the ABO Job should not continue, empty string or null if it should.

OnBeforeCreateDirectoryFolder

java.lang.String OnBeforeCreateDirectoryFolder(AActivitySpace _asCurrentSpace,
                                               IPTSession _ptUserSession,
                                               java.lang.String _strFolderName,
                                               java.lang.String _strFolderDescription)
This function will perform some functionality before the creation process of a Directory Folder.

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
_strFolderName - - Name of the folder being created
_strFolderDescription - - Description of the folder being created
Returns:
String - Error message if the creation should not continue, empty string or null if it should.

OnBeforeDeleteDirectoryFolder

java.lang.String OnBeforeDeleteDirectoryFolder(AActivitySpace _asCurrentSpace,
                                               IPTSession _ptUserSession,
                                               int _nFolderID)
This function will perform some functionality before the deletion process of a Directory Folder.

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
_nFolderID - - The specific folder being deleted
Returns:
String - Error message if the deletion should not continue, empty string or null if it should.

OnBeforeDeleteDocument

java.lang.String OnBeforeDeleteDocument(AActivitySpace _asCurrentSpace,
                                        IPTSession _ptUserSession,
                                        int _nDocumentID)
This function will perform some functionality before the deletion process of a Document.

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
_nDocumentID - - The specific document being deleted
Returns:
String - Error message if the deletion should not continue, empty string or null if it should.

OnClickThroughToDoc

Redirect OnClickThroughToDoc(AActivitySpace _asCurrentSpace,
                             IPTSession _ptUserSession,
                             int _nDocumentID)
This function will perform some functionality during the click through of a particular document and then perform a Redirect or return Null.

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
_nDocumentID - - Object ID of the Document trying to be viewed.
Returns:
Redirect - Location that the User will be redirected after the functionality has completed.

OnOpenFolder

Redirect OnOpenFolder(AActivitySpace _asCurrentSpace,
                      IPTSession _ptUserSession,
                      int _nFolderID)
This function will perform some functionality during the Opening of a folder within the directory structure and then perform a Redirect or return Null.

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
_nFolderID - - Object ID of the Folder trying to be viewed.
Returns:
Redirect - Location that the User will be redirected after the functionality has completed.



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