wt.clients.folderexplorer
Class WindchillExplorerTaskLogic

java.lang.Object
  extended bywt.clients.folderexplorer.WindchillExplorerTaskLogic

Deprecated. the Windchill Explorer and its supporting classes are being replaced in a future release by new clients that support lightweight customization and new client architecture.

public class WindchillExplorerTaskLogic
extends Object

Class WindchillExplorerTaskLogic provides static helper methods used by the WindchillExplorerFrame. These methods encapsulate the server-side processing logic.

Supported API: false

See Also:
WindchillExplorerFrame

Nested Class Summary
static class WindchillExplorerTaskLogic.HashMapServer
          Deprecated.  
 
Field Summary
private static com.objectspace.jgl.HashMap classesHashmap
          Deprecated.  
private static String CLASSNAME
          Deprecated.  
private static boolean DEBUG
          Deprecated.  
private static String MENU_RESOURCES
          Deprecated.  
private static ResourceBundle menuResources
          Deprecated.  
private static String nameSeparator
          Deprecated.  
 
Constructor Summary
WindchillExplorerTaskLogic()
          Deprecated.  
 
Method Summary
static void delete(CabinetBased folder_entry)
          Deprecated. Method delete deletes the given CabinetBased object from the database.
private static String extractClassName(String string)
          Deprecated.  
private static String extractDisplayName(String string)
          Deprecated. Returns a displayable string representation of the class associated with the given string.
private static Vector getClassStrings()
          Deprecated. Returns a Vector of Strings in which each String specifies a class to be included in or excluded from the classes that can be created in the Windchill Explorer.
static com.objectspace.jgl.HashMap getCreateableClasses()
          Deprecated. Returns a HashMap containing the classes of objects that can be created in the Windchill Explorer.
static String getDisplayName(String class_name)
          Deprecated. Given a String classname, return a more human-readable representation of that classname.
private static void initializeHashmap()
          Deprecated.  
private static void initResources()
          Deprecated.  
static boolean isUpdateAllowed(Cabinet cabinet)
          Deprecated.  
static boolean isUpdateAllowed(CabinetBased entry)
          Deprecated. Method isUpdateAllowed determines if the given CabinetBased object is available for updating by the current user.
private static void processResourceEntries()
          Deprecated. Uses the entries in the FolderExplorerMenuRB ResourceBundle to update the HashMap entries retrieved using Introspection.
static CabinetBased refresh(CabinetBased object)
          Deprecated. Return a refreshed copy of the given CabinetBased object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

classesHashmap

private static com.objectspace.jgl.HashMap classesHashmap
Deprecated. 

MENU_RESOURCES

private static String MENU_RESOURCES
Deprecated. 

menuResources

private static ResourceBundle menuResources
Deprecated. 

nameSeparator

private static String nameSeparator
Deprecated. 

CLASSNAME

private static final String CLASSNAME
Deprecated. 

DEBUG

private static boolean DEBUG
Deprecated. 
Constructor Detail

WindchillExplorerTaskLogic

public WindchillExplorerTaskLogic()
Deprecated. 
Method Detail

isUpdateAllowed

public static boolean isUpdateAllowed(CabinetBased entry)
                               throws LockException,
                                      WTException
Deprecated. 
Method isUpdateAllowed determines if the given CabinetBased object is available for updating by the current user. Availability for updating is checked based upon the following constraints:

Parameters:
entry - the CabinetBased entry for which the ability to be updated by the current user is checked.
Returns:
if true, the current user is allowed to update the given object
Throws:
LockException
WTException
See Also:
CabinetBased, Workable

isUpdateAllowed

public static boolean isUpdateAllowed(Cabinet cabinet)
                               throws WTException
Deprecated. 
Throws:
WTException

delete

public static void delete(CabinetBased folder_entry)
                   throws WTException
Deprecated. 
Method delete deletes the given CabinetBased object from the database.

Parameters:
folder_entry - the CabinetBased object to be deleted
Throws:
WTException

getDisplayName

public static String getDisplayName(String class_name)
Deprecated. 
Given a String classname, return a more human-readable representation of that classname. Uses WTIntrospector to get a class info object for the class name, then uses class_info.getDisplayName() to obtain the localized class name.

Returns:

getCreateableClasses

public static com.objectspace.jgl.HashMap getCreateableClasses()
                                                        throws WTIntrospectionException
Deprecated. 
Returns a HashMap containing the classes of objects that can be created in the Windchill Explorer.

Returns:
a HashMap in which the keys are the createable classes and the values corresponding to those keys are the display names
Throws:
WTIntrospectionException - if an error occurs getting the createable classes

initializeHashmap

private static void initializeHashmap()
                               throws WTIntrospectionException
Deprecated. 
Throws:
WTIntrospectionException

getClassStrings

private static Vector getClassStrings()
Deprecated. 
Returns a Vector of Strings in which each String specifies a class to be included in or excluded from the classes that can be created in the Windchill Explorer. The String entries take the form: String_Entry ::= Operator Classname [Display_Name] Operator ::= +|- Classname ::= a fully-qualified classname Display_Name ::= a descriptive name used for the class

Returns:
a Vector of Strings

initResources

private static void initResources()
Deprecated. 

processResourceEntries

private static void processResourceEntries()
Deprecated. 
Uses the entries in the FolderExplorerMenuRB ResourceBundle to update the HashMap entries retrieved using Introspection. The ResourceBundle can specify entries to be added and/or removed.


extractDisplayName

private static String extractDisplayName(String string)
Deprecated. 
Returns a displayable string representation of the class associated with the given string. This method receives a string which has been extracted from a ResourceBundle and converts that string into a display name. The given string is in the following form: String_Entry ::= Classname [Display_Name] Classname ::= a fully-qualified classname Display_Name ::= a descriptive name used for the class If the string does contain a display name, that display name is returned. Otherwise, a display name is taken from the class.

Parameters:
string - the string for which a display name is returned
Returns:
a displayable string name

extractClassName

private static String extractClassName(String string)
Deprecated. 

refresh

public static CabinetBased refresh(CabinetBased object)
                            throws ObjectNoLongerExistsException,
                                   WTException
Deprecated. 
Return a refreshed copy of the given CabinetBased object.

Parameters:
object - the CabinetBased to be refreshed
Returns:
the refreshed CabinetBased object.
Throws:
ObjectNoLongerExistsException - if the given object has been deleted from the database
WTException - if an error occurs retrieving a refreshed copy of the object from the database.