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

All Superinterfaces:
IClone
All Known Subinterfaces:
IConnectionDirectoryItem
All Known Implementing Classes:
ConnectionDirectoryItem, DirectoryItem

public interface IDirectoryItem
extends IClone

This interface defines an item under the data sources directory. Data sources available from the server are put in directory format for easy access. The types of directory items include folders, reports, and connections. Use the com.crystaldecisions.sdk.occa.report.application.ConnectionDirManager to retrieve specific types of directory items.


Method Summary
 DirectoryItems getChildren()
          Returns the child items that belong to the directory item.
 boolean getChildrenFetched()
           Returns whether the child items of the directory item have been fetched from the server.
 boolean getIsLeaf()
          Returns whether the directory item is a leaf (contains no child items).
 java.lang.String getName()
          Returns the name of the directory item.
 PropertyBag getUID()
          Returns the property bag object.
 void setChildren(DirectoryItems children)
          Sets the child items that belong to the directory item.
 void setChildrenFetched(boolean childrenFetched)
           Sets whether the child items of the directory item have been fetched from the server.
 

Method Detail

getChildren

DirectoryItems getChildren()

Returns the child items that belong to the directory item.

Use the getChildrenFetched() method to determine if the com.crystaldecisions.sdk.occa.report.application.ConnectionDirManager has been used to retrieve the child items from the server. When the child items are retrieved, the getChildren and getChildrenFetched are updated.

Returns:
The directory items as objects.

getChildrenFetched

boolean getChildrenFetched()

Returns whether the child items of the directory item have been fetched from the server.

Use the getChildrenFetched() method to determine if the com.crystaldecisions.sdk.occa.report.application.ConnectionDirManager has been used to retrieve the child items from the server. When the child items are retrieved, the getChildren and getChildrenFetched are updated.

Returns:
true if the child items of the directory item have been fetched from the server, and false otherwise.

getIsLeaf

boolean getIsLeaf()

Returns whether the directory item is a leaf (contains no child items).

Returns:
true if the directory item is a leaf (contains no child items), and false otherwise.

getName

java.lang.String getName()

Returns the name of the directory item.

Returns:
The directory item name as a String.

getUID

PropertyBag getUID()

Returns the property bag object. These properties uniquely identify the directory item.

Returns:
The PropertyBag object.

setChildren

void setChildren(DirectoryItems children)

Sets the child items that belong to the directory item.

Use the getChildrenFetched() method to determine if the com.crystaldecisions.sdk.occa.report.application.ConnectionDirManager has been used to retrieve the child items from the server. When the child items are retrieved, the getChildren and getChildrenFetched are updated.

Parameters:
children - The directory items.

setChildrenFetched

void setChildrenFetched(boolean childrenFetched)

Sets whether the child items of the directory item have been fetched from the server.

Use the getChildrenFetched() method to determine if the com.crystaldecisions.sdk.occa.report.application.ConnectionDirManager has been used to retrieve the child items from the server. When the child items are retrieved, the getChildren and getChildrenFetched are updated.

Parameters:
childrenFetched - true if the child items of the directory item have been fetched from the server, and false otherwise.