wt.folder.cache
Class FolderCache

java.lang.Object
  wt.folder.cache.FolderCache

Deprecated.

Supported API: false

Extendable: false

public final class FolderCache

extends Object

Obsoleted folder cache implementation.

Nested Class Summary

(package private) static class

FolderCache.Singleton Deprecated.

Field Summary

(package private) FolderCache

cache Deprecated.

Constructor Summary

private

FolderCache() Deprecated.

Method Summary

Vector	getAllCabinets(boolean copy, WTContainerRef container) Deprecated. Finds all Cabinets in the Windchill system.
Cabinet	getCabinet(String name, boolean copy, WTContainerRef container) Deprecated. finds the Cabinet with the given name
Cabinet	getCabinet(WTUser user, boolean copy) Deprecated. finds the Cabinet that is the personal cabinet of the given user
Folder	getChildFolder(Folder parent, String child) Deprecated. navigates from a parent Folder to a child given the name of the child
Folder	getFolder(ObjectIdentifier oid, boolean copy) Deprecated. finds the Folder with the given ObjectIdentifier
static FolderCache	getFolderCache() Deprecated.
String	getFolderName(ObjectIdentifier folder) Deprecated. finds the name of the Folder with the given ObjectIdentifier
ObjectIdentifier	getParentFolder(ObjectIdentifier child) Deprecated. navigates from a child Folder to its parent
Vector	getSubFolders(ObjectIdentifier parent_oid, boolean copy) Deprecated. navigates from a parent Folder to all of its children SubFolders

Methods inherited from class java.lang.Object

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

Field Detail

cache

FolderCache cache

Deprecated.

Constructor Detail

FolderCache

private FolderCache()

Deprecated.

Method Detail

getFolderCache

public static FolderCache getFolderCache()
                                  throws RemoteException,
                                         WTException

Deprecated.

Throws:

RemoteException

WTException

getParentFolder

public ObjectIdentifier getParentFolder(ObjectIdentifier child)
                                 throws WTException

Deprecated.

navigates from a child Folder to its parent

Parameters:

child - an ObjectIdentifier for a child Folder

Returns:

the ObjectIdentifier of the child's parent Folder, otherwise null if the child is a root Folder and has no parent

Throws:

WTException - if a low level error occurs

getChildFolder

public Folder getChildFolder(Folder parent,
                             String child)
                      throws WTException

Deprecated.

navigates from a parent Folder to a child given the name of the child

Parameters:

parent - the parent Folder

child - the name of the child Folder

Returns:

the child Folder

Throws:

WTException - if a low level error occurs

getSubFolders

public Vector getSubFolders(ObjectIdentifier parent_oid,
                            boolean copy)
                     throws WTException

Deprecated.

navigates from a parent Folder to all of its children SubFolders

Parameters:

parent_oid - the parent folder ObjectIdentifier

copy - controls whether or not copies of the cached SubFolders are returned

Returns:

a Vector of SubFolders

Throws:

WTException - if a low level error occurs

getFolder

public Folder getFolder(ObjectIdentifier oid,
                        boolean copy)
                 throws WTException

Deprecated.

finds the Folder with the given ObjectIdentifier

Parameters:

oid - the ObjectIdentifier of a Folder

copy - controls whether or not copies of the cached Folders are returned

Returns:

the Folder object, else null if the Folder doesn't exist

Throws:

WTException - if a low level exception occurs

getFolderName

public String getFolderName(ObjectIdentifier folder)
                     throws WTException,
                            ObjectNoLongerExistsException

Deprecated.

finds the name of the Folder with the given ObjectIdentifier

Parameters:

folder - the ObjectIdentifier of a Folder

Returns:

the folder's name

Throws:

WTException - if a low level exception occurs

ObjectNoLongerExistsException - if folder doesn't exist

getCabinet

public Cabinet getCabinet(String name,
                          boolean copy,
                          WTContainerRef container)
                   throws WTException

Deprecated.

finds the Cabinet with the given name

Parameters:

name - a Cabinet's name

copy - controls whether or not copies of the cached Cabinets are returned

container - a reference to the cabinet's container

Returns:

the Cabinet object, else null if the Cabinet doesn't exist

Throws:

WTException - if a low level exception occurs

getCabinet

public Cabinet getCabinet(WTUser user,
                          boolean copy)
                   throws WTException

Deprecated.

finds the Cabinet that is the personal cabinet of the given user

Parameters:

user - the user to whom the cabinet is their personal cabinet

copy - controls whether or not copies of the cached Cabinets are returned

Returns:

the Cabinet object, else null if the Cabinet doesn't exist

Throws:

WTException - if a low level exception occurs

getAllCabinets

public Vector getAllCabinets(boolean copy,
                             WTContainerRef container)
                      throws WTException

Deprecated.

Finds all Cabinets in the Windchill system. If the cache is configured to only cache shared Cabinets or no Cabinets then Cabinets not in the cache are retreived by querying the database.

Parameters:

copy - controls whether or not copies of the cached Cabinets are returned

container - a reference to the container to search in

Returns:

a Vector of all Cabinets in the system

Throws:

WTException - if a low level exception occurs