com.ibm.edms.od
Class ODCabinet

java.lang.Object
  com.ibm.edms.od.ODCabinet

public class ODCabinet
extends java.lang.Object

Class representing a collection of OnDemand Folders. Cabinets are defined and managed on the OnDemand Server by the OnDemand Administrator. See your OnDemand Administrator for more details.

Method Summary

java.lang.String	getDescription() Get the Description for this Cabinet.
java.lang.String[]	getFolderNames() Get the Folder Names defined to this Cabinet.
java.lang.String	getName() Get the Cabinet Name.
int	getNumFolders() Get the number of folders.
void	open() Open This Cabinet.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Get the Cabinet Name.

Returns:

String Cabinet Name

getDescription

public java.lang.String getDescription()

Get the Description for this Cabinet.

Returns:

String Cabinet Description.

open

public void open()
          throws java.lang.Exception

Open This Cabinet. This call will query the OnDemand Server for the specific folders defined in this Cabinet.

Throws:

java.lang.Exception

getFolderNames

public java.lang.String[] getFolderNames()

Get the Folder Names defined to this Cabinet.
NOTE: You must call ODCabinet.open() to populate the folder list.

Returns:

String[] Folder Names.

See Also:

ODCabinet.open()

getNumFolders

public int getNumFolders()

Get the number of folders.

Returns:

int numFolders.