|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
void OnAfterCreateABOJob(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nJobID, int _nClassID, int _nObjectID)
_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 deletevoid OnAfterCreateDirectoryFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nFolderID)
_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 createdvoid OnAfterDeleteDirectoryFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nFolderID)
_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 deletedjava.lang.String OnBeforeCreateABOJob(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nClassID, int _nObjectID)
_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
java.lang.String OnBeforeCreateDirectoryFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strFolderName, java.lang.String _strFolderDescription)
_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
java.lang.String OnBeforeDeleteDirectoryFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nFolderID)
_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
java.lang.String OnBeforeDeleteDocument(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nDocumentID)
_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
Redirect OnClickThroughToDoc(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nDocumentID)
_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.
Redirect OnOpenFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nFolderID)
_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.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |