com.crystaldecisions.sdk.occa.report.data
Interface IConnectionDirectory

All Superinterfaces:
IClone
All Known Implementing Classes:
ConnectionDirectory

public interface IConnectionDirectory
extends IClone

This interface is used to get and set information for a connection directory. ConnectionDirectoryItem objects can be passed as an argument to the getTables() method, which will in turn retrieve the item's database tables.


Method Summary
 java.lang.String getName()
          Returns the name of the connection directory.
 java.lang.String getRemoteID()
          Returns the ID of the remote connection directory.
 DirectoryItems getRoots()
          Retrieves the root items from each data source directory on the server.
 void setName(java.lang.String name)
          Sets the name of the connection directory.
 void setRemoteID(java.lang.String remoteID)
          Sets the ID of the remote connection directory.
 void setRoots(DirectoryItems items)
          Sets the root items from each data source directory on the server.
 

Method Detail

getName

java.lang.String getName()

Returns the name of the connection directory.

Returns:
The name of the connection directory as a String.

getRemoteID

java.lang.String getRemoteID()

Returns the ID of the remote connection directory.

Returns:
The ID of the remote connection directory as a String.

getRoots

DirectoryItems getRoots()

Retrieves the root items from each data source directory on the server. This method gets the top-level nodes of the Connection Directory Manager. The returned objects are stored in the DirectoryItems collection.

Once the DirectoryItems have been retrieved, use the GetChildren Method to retrieve the child nodes of each item. If the DirectoryItem is a ConnectionDirectoryItem Object, then it can be passed as an argument to the getTables() method, which will in turn retrieve the item's database tables.

Returns:
The root items from the data source directory on the server as a DirectoryItems object.

setName

void setName(java.lang.String name)

Sets the name of the connection directory.

Parameters:
name - The name of the connection directory as a String.

setRemoteID

void setRemoteID(java.lang.String remoteID)

Sets the ID of the remote connection directory.

Parameters:
remoteID - The ID of the remote connection directory as a String.

setRoots

void setRoots(DirectoryItems items)

Sets the root items from each data source directory on the server. This method sets the top-level nodes of the Connection Directory Manager. The objects are stored in the DirectoryItems collection.

Once the DirectoryItems have been retrieved, use the ITotallerNode.getChildren() Method to retrieve the child nodes of each item. If the DirectoryItem is a ConnectionDirectoryItem object, then it can be passed as an argument to the GetTables Method, which will in turn retrieve the item's database tables.

Parameters:
items - The root items form the data source directory on the server as a DirectoryItems object.