|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.DirectoryItem
public class DirectoryItem
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 |
---|
public DirectoryItem(IDirectoryItem src)
public DirectoryItem()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
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.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public DirectoryItems getChildren()
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.
getChildren
in interface IDirectoryItem
public boolean getChildrenFetched()
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.
getChildrenFetched
in interface IDirectoryItem
true
if the child items of the directory
item have been fetched from the server, and false
otherwise.public boolean getIsLeaf()
Returns whether the directory item is a leaf (contains no child items).
getIsLeaf
in interface IDirectoryItem
true
if the directory item is a leaf (contains no child items),
and false
otherwise.public java.lang.String getName()
IDirectoryItem
Returns the name of the directory item.
getName
in interface IDirectoryItem
String
.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.
String.
public DirectoryItemType getType()
Returns the type of the directory item. The types of directory items include folders, reports, and connections.
DirectoryItemType
.DirectoryItemType
public PropertyBag getUID()
IDirectoryItem
Returns the property bag object. These properties uniquely identify the directory item.
getUID
in interface IDirectoryItem
PropertyBag
object.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.
String
.public boolean hasContent(java.lang.Object srcCon)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
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.
java.io.IOException
public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setChildren(DirectoryItems children)
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.
setChildren
in interface IDirectoryItem
children
- The directory items.public void setChildrenFetched(boolean childrenFetched)
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.
setChildrenFetched
in interface IDirectoryItem
childrenFetched
- true
if the child items of the directory
item have been fetched from the server, and false
otherwise.public void setIsLeaf(boolean isLeaf)
Sets whether the directory item is a leaf (contains no child items).
isLeaf
- true
if the directory item is a leaf (contains no child items),
and false
otherwise.public void setName(java.lang.String name)
Sets the name of the directory item.
name
- The directory item name as a String
.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.
password
- The password as a String.
public void setType(DirectoryItemType type)
Sets the type of the directory item. The types of directory items include folders, reports, and connections.
type
- A DirectoryItemType
.DirectoryItemType
public void setUID(PropertyBag uID)
Sets the property bag object. These properties uniquely identify the directory item.
uID
- The PropertyBag
object.public void setUserName(java.lang.String userName)
userName
- java.lang.Stringpublic void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |