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.

(c) Copyright IBM Corp. 1993, 2015. All Rights Reserved

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseDescription() Get the base description of the cabinet.
java.lang.String	getBaseName() Get the base name of the cabinet.
java.lang.String	getDescription() Get the Description for the 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. If no NLS strings are defined that match whichever locale the ODServer is running in, this method will return the name the cabinet was created with. If a match made, the name string that is mapped to that locale will be returned.

Returns:

String cabinet name

getBaseName

public java.lang.String getBaseName()

Get the base name of the cabinet.

Returns:

String The cabinet base name. This is the name used to create the cabinet and your NLS setting does not effect the value returned.

getDescription

public java.lang.String getDescription()

Get the Description for the Cabinet. If no NLS strings are defined that match whichever locale the ODServer is running in, this method will return the description the cabinet was created with. If a match made, the description string that is mapped to that locale will be returned.

Returns:

String Cabinet Description.

getBaseDescription

public java.lang.String getBaseDescription()

Get the base description of the cabinet.

Returns:

String The cabinet base description. This is the description the cabinet was first created with and your NLS setting does not effect the value returned.

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.