|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IObjectActions
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.
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: Developers should be very careful implementing either of these
functions as these will be called every single time that a Move, Delete,
Copy, or Migrate is performed and it could hurt performance.
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 an Object. |
java.lang.String |
OnBeforeCopyAdminFolder(AActivitySpace _asCurrentSpace,
IPTSession _ptUserSession,
int _nCopiedFolderID,
int _nTargetFolderID)
This function will perform some functionality before an Admin Folder is copied. |
java.lang.String |
OnBeforeCopyObject(AActivitySpace _asCurrentSpace,
IPTSession _ptUserSession,
int _nClassID,
int _nObjectID,
int _nFolderID)
This function will perform some functionality before an Object is copied from a folder to another. |
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 an Object. |
java.lang.String[] |
OnBeforeCreateAdminFolder(AActivitySpace _asCurrentSpace,
IPTSession _ptUserSession,
java.lang.String _strFolderName,
java.lang.String _strFolderDesc)
This function will perform some functionality before the creation process of a Admin Folder |
java.lang.String |
OnBeforeDeleteAdminFolder(AActivitySpace _asCurrentSpace,
IPTSession _ptUserSession,
int _nFolderID)
This function will perform some functionality before the deletion process of a Admin Folder. |
java.lang.String |
OnBeforeDeleteObject(AActivitySpace _asCurrentSpace,
IPTSession _ptUserSession,
int _nClassID,
int _nObjectID)
This function will perform some functionality before the deletion process of a set of objects. |
java.lang.String |
OnBeforeMigrateObject(AActivitySpace _asCurrentSpace,
IPTSession _ptUserSession,
int _nClassID,
int[] _arrObjectIDs)
This function will perform some functionality during the Migration process of a set of objects. |
java.lang.String |
OnBeforeMoveObject(AActivitySpace _asCurrentSpace,
IPTSession _ptUserSession,
int _nClassID,
int _nObjectID,
int _nFolderID)
This function will perform some functionality or validation before the move process of a object. |
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 deletejava.lang.String OnBeforeCopyAdminFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nCopiedFolderID, int _nTargetFolderID)
_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_nCopiedFolderID
- - ID of the folder being copied_nTargetFolderID
- - ID of the new folder
java.lang.String OnBeforeCopyObject(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nClassID, int _nObjectID, 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_nClassID
- - The type of object being copied_nObjectID
- - The specific object being copied_nFolderID
- - The Folder for which the objects will be moving to.
java.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[] OnBeforeCreateAdminFolder(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, java.lang.String _strFolderName, java.lang.String _strFolderDesc)
_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
- - The name for the specified Admin Folder_strFolderDesc
- - Description of the specified Admin Folder
java.lang.String OnBeforeDeleteAdminFolder(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 admin folder being deleted
java.lang.String OnBeforeDeleteObject(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
- - The type of object being deleted_nObjectID
- - The specific object being deleted
java.lang.String OnBeforeMigrateObject(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nClassID, int[] _arrObjectIDs)
_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
- - The type of object being migrated_arrObjectIDs
- - The specific set of objects being migrated.
java.lang.String OnBeforeMoveObject(AActivitySpace _asCurrentSpace, IPTSession _ptUserSession, int _nClassID, int _nObjectID, 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_nClassID
- - The type of object being moved._nObjectID
- - The specific objects being moved_nFolderID
- - The Folder for which the objects will be moving to.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |