|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDocument
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 |
---|
java.lang.String getName()
Returns the name of the report document as a String
.
String
.
If no name was supplied, the
name is the document's file name without path information
or an extension.int getOptions()
Returns the options that are set for the report document.
int
.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. 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.
PropertyBag
.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.
name
- The name of the report document as a String
.void setOptions(int options)
Sets the options for the report document. Refer to DocumentOptions
for field values.
options
- The options that are set for the report document as an int
.void setRemoteID(java.lang.String remoteID)
For internal use only.
void setTimestamp(java.util.Date newVal)
Sets the time stamp.
newVal
- The time stamp for the document. This is represented by
the milliseconds since January 1, 1970, 00:00:00 GMT.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.
uID
- The PropertyBag
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |