wt.clients.folderexplorer
Class FolderBusinessObject

java.lang.Object
  wt.clients.beans.explorer.WTBusinessObject
      wt.clients.folderexplorer.FolderBusinessObject

All Implemented Interfaces:

Serializable, Explorable, Identifiable, ReferenceHolder

public class FolderBusinessObject
extends WTBusinessObject

Class FolderBusinessObject provides a wrapper class for objects that appear in the WindchillExplorer. This class is used as a wrapper for all objects that are Folders. This class is necessary because the WTExplorer, which is the basis for the WindchillExplorer, manipulates WTBusinessObjects.

Supported API: true

Extendable: false

See Also:

WTBusinessObject, Folder, Serialized Form

Nested Class Summary

class

wt.clients.folderexplorer.FolderBusinessObject.LiteObjectProvider

Constructor Summary

FolderBusinessObject(String identity, Folder folder)
Constructor for class FolderBusinessObject.

Method Summary

Explorable[]	getContents() Method getContents is invoked by the WTExplorer in response to a Folder being selected in the treeview.
WTBusinessObject[]	getDetails() Method getDetails retrieves all of the folder contents of the Folder wrapped by this object.
Folder	getFolder() Returns the Folder object that is being wrapped by this object.
Explorable[]	getUses() Method getUses is invoked by the WTExplorer when a node in the treeview is expanded.
boolean	isEqual(Folder folder) Method isEqual is a convenience method to determine if a given Folder object is the same object as the Folder object being wrapped by this object.
void	setFolder(Folder folder) Sets the Folder object that is being wrapped by this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderBusinessObject

public FolderBusinessObject(String identity,
                            Folder folder)

Constructor for class FolderBusinessObject.

Parameters:

identity - the String used to identify this object

folder - the Folder object that is being wrapped by this object

See Also:

wt.clients.beans.WTBusinessObject,

Supported API: true

Method Detail

getFolder

public Folder getFolder()

Returns the Folder object that is being wrapped by this object.

Returns:

the Folder object wrapped by this object

See Also:

setFolder(wt.folder.Folder),

Supported API: true

setFolder

public void setFolder(Folder folder)

Sets the Folder object that is being wrapped by this object.

Parameters:

folder - the Folder object wrapped by this object

See Also:

getFolder(),

Supported API: true

getContents

public Explorable[] getContents()
                         throws WTException

Method getContents is invoked by the WTExplorer in response to a Folder being selected in the treeview. This method retrieves all of the contents of the Folder object wrapped by this object to be displayed in the detail view of the Windchill Explorer.

Returns:

an Array of Explorable objects which represent the contents of the Folder object wrapped by this object

Throws:

WTException

See Also:

Explorable,

Supported API: true

getUses

public Explorable[] getUses()

Method getUses is invoked by the WTExplorer when a node in the treeview is expanded. This method retrieves all of the Folders which are subfolders of the Folder object wrapped by this object. The subfolders are wrapped as FolderBusinessObjects.

Returns:

an array of Explorable objects which contain the Folders that are subfolders of the Folder wrapped by this object

See Also:

Explorable,

Supported API: true

getDetails

public WTBusinessObject[] getDetails()
                              throws WTException

Method getDetails retrieves all of the folder contents of the Folder wrapped by this object. The folder contents are wrapped as FolderedBusinessObjects. Both SubFolders and FolderEntry objects that are contained in this Folder are returned.

Returns:

an array of WTBusinessObjects which contain the folder contents of the Folder wrapped by this object

Throws:

WTException

See Also:

WTBusinessObject, FolderedBusinessObject, Folder,

Supported API: true

isEqual

public boolean isEqual(Folder folder)

Method isEqual is a convenience method to determine if a given Folder object is the same object as the Folder object being wrapped by this object. Note that this method is not checking if the two Folder objects have the same values, but rather that the two objects are references to the same Folder object.

Parameters:

folder - the Folder object to be compared for equality with the Folder wrapped by this object

Returns:

if true, the given Folder and the Folder wrapped by this object reference the same Folder object

Supported API: true