com.ptc.windchill.uwgm.common.folder
Class FolderHelper

java.lang.Object
  extended bycom.ptc.windchill.uwgm.common.folder.FolderHelper

public final class FolderHelper
extends Object

Helper to retrieve folder information.


Nested Class Summary
static class FolderHelper.FolderInfo
          Simple data structure to return information about a folder.
static class FolderHelper.FolderType
          Enumeration for folder types
 
Field Summary
static FolderHelper.FolderType FT_CONTAINER
           
static FolderHelper.FolderType FT_REGULAR
           
static FolderHelper.FolderType FT_TOP_FOLDER
           
static FolderHelper.FolderType FT_UNKNOWN
           
static FolderHelper.FolderType FT_WORKSPACE
           
private static Log log
           
private static String SLASH
           
 
Constructor Summary
private FolderHelper()
           
 
Method Summary
private static Map getAccessibleObjectsMap(Collection oids, Class cl)
           
private static Map getCabinetsMap(WTCollection cabinetBased)
           
private static Map getContainersMap(WTCollection contained)
           
static WTKeyedMap getFolderInfo(WTCollection folders, Locale locale)
          For a collection of wt.folder.Folder objects retrieve information about location, etc.
private static Map getOrganizationsMap(Collection organizationOwned)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static Log log

SLASH

private static final String SLASH

FT_UNKNOWN

public static final FolderHelper.FolderType FT_UNKNOWN

FT_REGULAR

public static final FolderHelper.FolderType FT_REGULAR

FT_TOP_FOLDER

public static final FolderHelper.FolderType FT_TOP_FOLDER

FT_CONTAINER

public static final FolderHelper.FolderType FT_CONTAINER

FT_WORKSPACE

public static final FolderHelper.FolderType FT_WORKSPACE
Constructor Detail

FolderHelper

private FolderHelper()
Method Detail

getFolderInfo

public static WTKeyedMap getFolderInfo(WTCollection folders,
                                       Locale locale)
                                throws WTException
For a collection of wt.folder.Folder objects retrieve information about location, etc. Resulting map: [Folder, FolderHelper.FolderInfo].

Parameters:
folders - WTCollection
locale - Locale
Returns:
WTKeyedMap
Throws:
WTException

getCabinetsMap

private static Map getCabinetsMap(WTCollection cabinetBased)
                           throws WTException
Throws:
WTException

getContainersMap

private static Map getContainersMap(WTCollection contained)
                             throws WTException
Throws:
WTException

getOrganizationsMap

private static Map getOrganizationsMap(Collection organizationOwned)
                                throws WTException
Throws:
WTException

getAccessibleObjectsMap

private static Map getAccessibleObjectsMap(Collection oids,
                                           Class cl)
                                    throws WTException
Throws:
WTException