com.crystaldecisions.sdk.occa.report.document
Interface IDocument

All Superinterfaces:
IClone
All Known Subinterfaces:
IDataDocument, IReportDocument
All Known Implementing Classes:
DataDocument, ReportDocument

public interface IDocument
extends IClone

This interface enables you to get and set basic information for the document.


Method Summary
 java.lang.String getName()
          Returns the name of the report document as a String.
 int getOptions()
          Returns the options that are set for the report document.
 java.lang.String getRemoteID()
          For internal use only.
 java.util.Date getTimestamp()
          Returns the time stamp.
 PropertyBag getUID()
          Returns the UID, which are properties that uniquely identify the directory item.
 void setName(java.lang.String name)
          Sets the name of the report document as a String.
 void setOptions(int options)
          Sets the options for the report document.
 void setRemoteID(java.lang.String remoteID)
          For internal use only.
 void setTimestamp(java.util.Date newVal)
          Sets the time stamp.
 void setUID(PropertyBag uID)
          Sets the UID, which are properties that uniquely identify the directory item.
 

Method Detail

getName

java.lang.String getName()

Returns the name of the report document as a String.

Returns:
The name of the report document as a String. If no name was supplied, the name is the document's file name without path information or an extension.

getOptions

int getOptions()

Returns the options that are set for the report document.

Returns:
The options that are set for the report document as an int.

getRemoteID

java.lang.String getRemoteID()

For internal use only.


getTimestamp

java.util.Date getTimestamp()

Returns the time stamp.

Returns:
The time stamp for the document. This is represented by the milliseconds since January 1, 1970, 00:00:00 GMT.

getUID

PropertyBag getUID()

Returns the UID, which are properties that uniquely identify the directory item. Use the properties in the returned property bag to help identify the directory item. For example, you can retrieve a report's name or a connection's location from the property bag and display it in the ConnectionDirManager tree structure.

Returns:
The PropertyBag.

setName

void setName(java.lang.String name)

Sets the name of the report document as a String. If no name is supplied, the name is the document's file name without path information or an extension.

Parameters:
name - The name of the report document as a String.

setOptions

void setOptions(int options)

Sets the options for the report document. Refer to DocumentOptions for field values.

Parameters:
options - The options that are set for the report document as an int.

setRemoteID

void setRemoteID(java.lang.String remoteID)

For internal use only.


setTimestamp

void setTimestamp(java.util.Date newVal)

Sets the time stamp.

Parameters:
newVal - The time stamp for the document. This is represented by the milliseconds since January 1, 1970, 00:00:00 GMT.

setUID

void setUID(PropertyBag uID)

Sets the UID, which are properties that uniquely identify the directory item. Use the properties in the returned property bag to help identify the directory item. For example, you can retrieve a report's name or a connection's location from the property bag and display it in the ConnectionDirManager tree structure.

Parameters:
uID - The PropertyBag.