com.plumtree.portalpages.admin.objcommon
Class AdminModelHelper

java.lang.Object
  com.plumtree.portalpages.admin.objcommon.AdminModelHelper

public class AdminModelHelper
extends java.lang.Object

Author:

Matt Fryer Helper class that ObjMgrModel and AdminSearchModel use.

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME

Constructor Summary

AdminModelHelper()

Method Summary

void	ABODeleteFolders(int[] nFolders) This method creates a job to delete folders using Asynchronous Browser Operations (ABO).
void	ABODeletePageTemplates(int[] nPageTemplates)
void	AddDependentTypes(int _nCurrentType, XPArrayList _xpSortedTypes, XPHashtable _xpTypesToDelete, XPArrayList _xpInProcessTypes) This method takes a class type and adds it and it's dependent class types to a list, if they are present in the hashtable.
boolean	CheckAuthSourceForDelete(int nCurrentFolderID)
boolean	CheckFoldersForDelete() This method checks whether or not the user is trying to delete any folders.
boolean	CheckIsCommunityFolder(int nFolderID)
protected boolean	CheckObjectsFromExternalAuthSource(int nObjectCount, int nCurrentFolderID, int nClassID, int nAuthSourcePropID) This helper method checks whether any of the objects for deletion are from an external authentication source.
boolean	CheckPageTemplatesForDelete() This method checks whether or not the user is trying to delete any page templates.
void	CleanupAllData()
void	CleanupTempData()
java.lang.String	ConcatenateErrors(java.lang.String _strFirstError, java.lang.String _strSecondError) This method concatenates two error messages into a single message with proper internationalized spacing between the messages.
void	CopyCards(int[] cardIds, int toFolder)
void	CopyDocumentFolders(int[] folderIDs, int toFolder)
void	CopyFolders(int nTargetFolderID, int[] nFolders) This method copies folders to a new folder.
void	CopyObjectsBetweenFolders(int nFolderID, XPHashtable xpmObjects, int nCurrentFolderID) This method copies objects between folders.
void	DeleteCards(int[] cards, int[] folders)
void	DeleteDocumentFolders(int[] documentFolders)
void	DeleteFolders(int[] nFolders) This method deletes folders.
void	DeleteObjects(XPHashtable xpmObjects, boolean bABODeleteObjects) This method deletes objects.
void	DoMove(java.lang.Object[][] nObjects, java.lang.Object[][] nFolders, int nFolderID)
void	EnableObjects(XPHashtable xpmObjects, java.lang.String sComment, boolean bEnable) This method enables and disables users and web services.
int[]	GetABOJobIDs()
boolean	GetABOJobIDsToDisplay()
java.lang.String[]	GetABOJobNames(int[] nABOJobIDs)
java.lang.String	GetAdminFolderPath(int folderID)
protected int[]	GetAllFoldersForCard(int cardId)
int[]	GetAllObjectTypesArray()
java.lang.String	GetAllObjectTypesString()
int	GetCommunityID(int nFolderID, int defaultFolderID)
java.lang.String	GetFolderErrorString(int nErrorID, int nCurrentFolderID) This method is used to get and format an error message where the only arg in the message is a folder name.
int	GetFolderIDFromTree(java.lang.String subspaceKey) This method gets the selected folder from the tree sub space.
boolean	GetFolderIsCommunity(IPTAdminFolder folder)
boolean	GetFolderIsSubportal(IPTAdminFolder folder)
java.lang.String	GetFolderTreeID()
ObjectManagerHolder	GetObjMgrHolder(int nClassID) This method returns the requested object manager holder, instantiating it if it was not cached.
XPHashtable	GetObjMgrs()
int	GetRootFolderID()
java.lang.String	GetSpaceID() Get the SpaceID of the parent Activity Space
void	Init(AActivitySpace parent)
void	MigrateFolders(int[] nFolderIDs, java.lang.String sComment) This method adds folders into the migration queue.
void	MigrateObjects(int nClassID, int[] nObjects, java.lang.String sComment) This method adds objects into the migration queue.
void	MigrateObjects(XPHashtable xpmObjects, java.lang.String sComment) This method adds objects into the migration queue.
void	MoveCards(int[] arCardIDs, int nFromFolder, int nTargetFolder)
void	MoveCards(int fromFolder, int cardId, int toFolder)
void	MoveDocumentFolders(int[] foldersToMove, int targetFolder)
void	MoveFolders(int nTargetFolderID, int[] nFolders) This method moves folders to a new folder.
void	MoveObjectsBetweenFolders(int nFolderID, java.lang.Object[][] nObjects, java.lang.Object[][] nFolders) This method moves objects between folders.
void	RaiseError(java.lang.String strError) This method raises a UI Error.
void	RefreshResults(java.lang.String key)
void	SetFoldersForDeleteCheck(boolean tf)
void	SetObjectsForDeleteCheck(int[] nObjectIDPairs) This method is used to set the list of folder IDs (temporary) to be checked for delete.
void	SetSelectedObjects(int nClassID, int[] nSelectedObjectIDs) This method sets the selected items in a Class ID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

AdminModelHelper

public AdminModelHelper()

Method Detail

CleanupTempData

public void CleanupTempData()

See Also:

IModel.CleanupTempData()

CleanupAllData

public void CleanupAllData()

See Also:

IModel.CleanupAllData()

CopyFolders

public void CopyFolders(int nTargetFolderID,
                        int[] nFolders)

This method copies folders to a new folder.

Parameters:

int - nTargetFolderID the ID of the folder to copy the folders to.

int[] - nFolders an array of folder IDs.

CopyObjectsBetweenFolders

public void CopyObjectsBetweenFolders(int nFolderID,
                                      XPHashtable xpmObjects,
                                      int nCurrentFolderID)

This method copies objects between folders.

Parameters:

int - nFolderID the ID of the folder to copy the objects to.

XPHashtable - a map of Integer Class IDs to int[] arrays of object IDs.

int - nCurrentFolderID -1 means all folders

DeleteCards

public void DeleteCards(int[] cards,
                        int[] folders)

GetAllFoldersForCard

protected int[] GetAllFoldersForCard(int cardId)

DeleteDocumentFolders

public void DeleteDocumentFolders(int[] documentFolders)

DeleteFolders

public void DeleteFolders(int[] nFolders)

This method deletes folders.

Parameters:

int[] - the folder IDs to delete

GetABOJobIDsToDisplay

public boolean GetABOJobIDsToDisplay()

See Also:

com.plumtree.portalpages.admin.objmgr.IObjMgrModelRO#ABOJobIDsToDisplay()

GetABOJobNames

public java.lang.String[] GetABOJobNames(int[] nABOJobIDs)

See Also:

IObjMgrModelRO.GetABOJobIDs()

GetABOJobIDs

public int[] GetABOJobIDs()

See Also:

IObjMgrModelRO.GetABOJobIDs()

ABODeleteFolders

public void ABODeleteFolders(int[] nFolders)

This method creates a job to delete folders using Asynchronous Browser Operations (ABO).

Parameters:

int[] - the folder IDs to delete

ABODeletePageTemplates

public void ABODeletePageTemplates(int[] nPageTemplates)

AddDependentTypes

public void AddDependentTypes(int _nCurrentType,
                              XPArrayList _xpSortedTypes,
                              XPHashtable _xpTypesToDelete,
                              XPArrayList _xpInProcessTypes)

This method takes a class type and adds it and it's dependent class types to a list, if they are present in the hashtable. The list will be sorted with dependent class types (e.g. portlets) coming before the class types they depend on (e.g. Portlet Web Services). This method only takes simple dependencies into account and cannot handle dependency loops. It shouldn't go into an infinite loops, but the resulting order is undefined.

Parameters:

_nCurrentType - The class type to check for dependent class types.

_xpSortedTypes - The List of class types sorted by dependency.

_xpTypesToDelete - The hashtable of types to delete.

_xpInProcessTypes - The List of types that are currently being processed. This is used to avoid infinite loops. This can be null.

DeleteObjects

public void DeleteObjects(XPHashtable xpmObjects,
                          boolean bABODeleteObjects)

This method deletes objects.

Parameters:

XPHashtable - a map of Integer Class IDs to int[] arrays of object IDs.

EnableObjects

public void EnableObjects(XPHashtable xpmObjects,
                          java.lang.String sComment,
                          boolean bEnable)

This method enables and disables users and web services.

GetCommunityID

public int GetCommunityID(int nFolderID,
                          int defaultFolderID)

See Also:

com.plumtree.portalpages.admin.objmgr.IObjMgrModelRO#GetCommunityID()

GetFolderIsCommunity

public boolean GetFolderIsCommunity(IPTAdminFolder folder)

See Also:

IObjMgrModelRO.GetCurrentFolderIsCommunity()

GetFolderIsSubportal

public boolean GetFolderIsSubportal(IPTAdminFolder folder)

See Also:

IObjMgrModelRO.GetCurrentFolderIsSubportal()

GetFolderIDFromTree

public int GetFolderIDFromTree(java.lang.String subspaceKey)

This method gets the selected folder from the tree sub space.

Returns:

int the folder ID (-1 implies error)

GetFolderTreeID

public java.lang.String GetFolderTreeID()

See Also:

IObjMgrModelRO.GetFolderTreeID()

GetRootFolderID

public int GetRootFolderID()

GetAllObjectTypesString

public java.lang.String GetAllObjectTypesString()

GetAllObjectTypesArray

public int[] GetAllObjectTypesArray()

GetSpaceID

public java.lang.String GetSpaceID()

Get the SpaceID of the parent Activity Space

Returns:

int m_asOwner.GetSpaceID();

Init

public void Init(AActivitySpace parent)

See Also:

com.plumtree.xpshared.activityspace.IModel#Init()

MigrateFolders

public void MigrateFolders(int[] nFolderIDs,
                           java.lang.String sComment)

This method adds folders into the migration queue.

MigrateObjects

public void MigrateObjects(XPHashtable xpmObjects,
                           java.lang.String sComment)

This method adds objects into the migration queue.

MigrateObjects

public void MigrateObjects(int nClassID,
                           int[] nObjects,
                           java.lang.String sComment)

This method adds objects into the migration queue.

MoveFolders

public void MoveFolders(int nTargetFolderID,
                        int[] nFolders)

This method moves folders to a new folder.

Parameters:

int - nTargetFolderID the ID of the folder to move the folders to.

int[] - nFolders an array of folder IDs.

MoveObjectsBetweenFolders

public void MoveObjectsBetweenFolders(int nFolderID,
                                      java.lang.Object[][] nObjects,
                                      java.lang.Object[][] nFolders)

This method moves objects between folders.

Parameters:

int - nFolderID the ID of the folder to move the objects to.

Object[][] - nObjects an (2 x n) array of class IDs / Object IDs

RefreshResults

public void RefreshResults(java.lang.String key)

DoMove

public void DoMove(java.lang.Object[][] nObjects,
                   java.lang.Object[][] nFolders,
                   int nFolderID)

MoveCards

public void MoveCards(int[] arCardIDs,
                      int nFromFolder,
                      int nTargetFolder)

RaiseError

public void RaiseError(java.lang.String strError)

This method raises a UI Error.

Parameters:

strError -

ConcatenateErrors

public java.lang.String ConcatenateErrors(java.lang.String _strFirstError,
                                          java.lang.String _strSecondError)

This method concatenates two error messages into a single message with proper internationalized spacing between the messages. This method will check both error messages for null and empty string values.

Parameters:

_strFirstError - The first error. May be null or empty string.

_strSecondError - The second error. May be null or empty string.

Returns:

The combined error string. Will be either null or a valid error string.

SetSelectedObjects

public void SetSelectedObjects(int nClassID,
                               int[] nSelectedObjectIDs)

This method sets the selected items in a Class ID

Parameters:

int - nClassID the class ID of the selected items

int[] - nSelectedObjectIDs the selected object IDs

CheckIsCommunityFolder

public boolean CheckIsCommunityFolder(int nFolderID)

Parameters:

nFolderID -

Returns:

GetFolderErrorString

public java.lang.String GetFolderErrorString(int nErrorID,
                                             int nCurrentFolderID)

This method is used to get and format an error message where the only arg in the message is a folder name.

Parameters:

int - nErrorID the id in the xml file

int - nCurrentFolderID the id of the folder to use the name of

Returns:

String the error message

GetObjMgrHolder

public ObjectManagerHolder GetObjMgrHolder(int nClassID)

This method returns the requested object manager holder, instantiating it if it was not cached.

Returns:

ObjectManagerHolder the obj mgr holder -- null on failure

CheckAuthSourceForDelete

public boolean CheckAuthSourceForDelete(int nCurrentFolderID)

CheckObjectsFromExternalAuthSource

protected boolean CheckObjectsFromExternalAuthSource(int nObjectCount,
                                                     int nCurrentFolderID,
                                                     int nClassID,
                                                     int nAuthSourcePropID)

This helper method checks whether any of the objects for deletion are from an external authentication source.

Parameters:

nObjectCount -

nCurrentFolderID -

nClassID -

nAuthSourcePropID -

Returns:

true implies there were objects from an external auth source.

CheckPageTemplatesForDelete

public boolean CheckPageTemplatesForDelete()

This method checks whether or not the user is trying to delete any page templates.

Returns:

true implies page templates are being deleted

CheckFoldersForDelete

public boolean CheckFoldersForDelete()

This method checks whether or not the user is trying to delete any folders.

Returns:

true implies folders are being deleted

SetObjectsForDeleteCheck

public void SetObjectsForDeleteCheck(int[] nObjectIDPairs)

This method is used to set the list of folder IDs (temporary) to be checked for delete.

Parameters:

int[] - of object class id / object id pairs.

SetFoldersForDeleteCheck

public void SetFoldersForDeleteCheck(boolean tf)

GetAdminFolderPath

public java.lang.String GetAdminFolderPath(int folderID)

MoveDocumentFolders

public void MoveDocumentFolders(int[] foldersToMove,
                                int targetFolder)

MoveCards

public void MoveCards(int fromFolder,
                      int cardId,
                      int toFolder)

CopyCards

public void CopyCards(int[] cardIds,
                      int toFolder)

Parameters:

cardIds -

toFolder -

CopyDocumentFolders

public void CopyDocumentFolders(int[] folderIDs,
                                int toFolder)

Parameters:

folderIDs -

toFolder -

GetObjMgrs

public XPHashtable GetObjMgrs()