com.crystaldecisions.sdk.occa.report.data
Class DirectoryItem

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.DirectoryItem
All Implemented Interfaces:
IDirectoryItem, IClone
Direct Known Subclasses:
ConnectionDirectoryItem

public class DirectoryItem
extends java.lang.Object
implements IDirectoryItem, IClone

This object implements 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. When possible, use the IDirectoryItem interface to manipulate this object. Use the com.crystaldecisions.sdk.occa.report.application.ConnectionDirManager to retrieve specific types of directory items.


Constructor Summary
DirectoryItem()
           
DirectoryItem(IDirectoryItem src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 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.
 java.lang.String getPassword()
          Returns the password to connect to the data source.
 DirectoryItemType getType()
          Returns the type of the directory item.
 PropertyBag getUID()
          Returns the property bag object.
 java.lang.String getUserName()
          Returns the password to connect to the data source.
 boolean hasContent(java.lang.Object srcCon)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
          For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          For internal use only.
 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.
 void setIsLeaf(boolean isLeaf)
          Sets whether the directory item is a leaf (contains no child items).
 void setName(java.lang.String name)
          Sets the name of the directory item.
 void setPassword(java.lang.String password)
          Returns the password to connect to the data source.
 void setType(DirectoryItemType type)
          Sets the type of the directory item.
 void setUID(PropertyBag uID)
          Sets the property bag object.
 void setUserName(java.lang.String userName)
          Insert the method's description here.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DirectoryItem

public DirectoryItem(IDirectoryItem src)

DirectoryItem

public DirectoryItem()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getChildren

public DirectoryItems getChildren()
Description copied from interface: IDirectoryItem

Returns the child items that belong to the directory item.

Use the IDirectoryItem.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.

Specified by:
getChildren in interface IDirectoryItem
Returns:
The directory items as objects.

getChildrenFetched

public boolean getChildrenFetched()
Description copied from interface: IDirectoryItem

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.

Specified by:
getChildrenFetched in interface IDirectoryItem
Returns:
true if the child items of the directory item have been fetched from the server, and false otherwise.

getIsLeaf

public boolean getIsLeaf()

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

Specified by:
getIsLeaf in interface IDirectoryItem
Returns:
true if the directory item is a leaf (contains no child items), and false otherwise.

getName

public java.lang.String getName()
Description copied from interface: IDirectoryItem

Returns the name of the directory item.

Specified by:
getName in interface IDirectoryItem
Returns:
The directory item name as a String.

getPassword

public java.lang.String getPassword()

Returns the password to connect to the data source. If the directory item is a secure data source, then you will want to set a password and user name to log on to it.

Returns:
The password as a String.

getType

public DirectoryItemType getType()

Returns the type of the directory item. The types of directory items include folders, reports, and connections.

Returns:
A DirectoryItemType.
See Also:
DirectoryItemType

getUID

public PropertyBag getUID()
Description copied from interface: IDirectoryItem

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

Specified by:
getUID in interface IDirectoryItem
Returns:
The PropertyBag object.

getUserName

public java.lang.String getUserName()

Returns the password to connect to the data source. If the directory item is a secure data source, then you will want to use the Password property and the UserName property to log on to it.

Returns:
The user name as a String.

hasContent

public boolean hasContent(java.lang.Object srcCon)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 java.lang.String sTag,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer,
                         com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setChildren

public void setChildren(DirectoryItems children)
Description copied from interface: IDirectoryItem

Sets the child items that belong to the directory item.

Use the IDirectoryItem.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.

Specified by:
setChildren in interface IDirectoryItem
Parameters:
children - The directory items.

setChildrenFetched

public void setChildrenFetched(boolean childrenFetched)
Description copied from interface: IDirectoryItem

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

Use the IDirectoryItem.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.

Specified by:
setChildrenFetched in interface IDirectoryItem
Parameters:
childrenFetched - true if the child items of the directory item have been fetched from the server, and false otherwise.

setIsLeaf

public void setIsLeaf(boolean isLeaf)

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

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

setName

public void setName(java.lang.String name)

Sets the name of the directory item.

Parameters:
name - The directory item name as a String.

setPassword

public void setPassword(java.lang.String password)

Returns the password to connect to the data source. If the directory item is a secure data source, then you will want to set a password and user name to log on to it.

Parameters:
password - The password as a String.

setType

public void setType(DirectoryItemType type)

Sets the type of the directory item. The types of directory items include folders, reports, and connections.

Parameters:
type - A DirectoryItemType.
See Also:
DirectoryItemType

setUID

public void setUID(PropertyBag uID)

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

Parameters:
uID - The PropertyBag object.

setUserName

public void setUserName(java.lang.String userName)
Insert the method's description here. Creation date: (7/13/2001 5:33:32 PM)

Parameters:
userName - java.lang.String

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.