com.crystaldecisions.sdk.occa.report.document
Class ReportDocument

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.document.DataDocument
      extended by com.crystaldecisions.sdk.occa.report.document.ReportDocument
All Implemented Interfaces:
IDataDocument, IDocument, IReportDocument, IClone

public class ReportDocument
extends DataDocument
implements IReportDocument

The object enables you to get and set report document information.


Constructor Summary
ReportDocument()
           
ReportDocument(IReportDocument src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
          Returns the new object that has been cloned.
 void copyTo(java.lang.Object destObject, boolean deepCopy)
          Copies the object.
 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 doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 int getMajorVersion()
          Returns the major version number of the report's format.
 int getMinorVersion()
          Returns the minor version number of the report's format.
 IPrintOptions getPrintOptions()
           For internal use only.
 ReportDefinition getReportDefinition()
          Returns IReportDefinition, which contains areas, sections, and report objects in the report.
 IReportOptions getReportOptions()
          Returns IReportOptions.
 ISummaryInfo getSummaryInfo()
          Returns the report's summary information.
 boolean hasContent(java.lang.Object obj)
          Returns whether or not an object has content.
 boolean isDirectlyControllable()
           
 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(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setMajorVersion(int majorVersion)
          Sets the major version number of the report's format.
 void setMinorVersion(int minorVersion)
          Sets the minor version number of the report's format.
 void setPrintOptions(IPrintOptions printOptions)
           For internal use only.
 void setReportDefinition(IReportDefinition reportDef)
          Sets IReportDefinition, which contains areas, sections, and report objects in the report.
 void setReportOptions(IReportOptions reportOptions)
          Sets IReportOptions.
 void setSummaryInfo(ISummaryInfo summaryInfo)
          Sets the report's summary information.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.document.DataDocument
getControllableMixin, getDatabase, getDataDefinition, getName, getOptions, getRemoteID, getTimestamp, getUID, setDatabase, setDataDefinition, setName, setOptions, setRemoteID, setTimestamp, setUID
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.document.IDataDocument
getDatabase, getDataDefinition, setDatabase, setDataDefinition
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.document.IDocument
getName, getOptions, getRemoteID, getTimestamp, getUID, setName, setOptions, setRemoteID, setTimestamp, setUID
 

Constructor Detail

ReportDocument

public ReportDocument(IReportDocument src)

ReportDocument

public ReportDocument()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

Returns the new object that has been cloned.

Overrides:
clone in class DataDocument
Parameters:
deepClone - true to use deep clone, false to use shallow.
Returns:
The new object that has been cloned.

copyTo

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

Copies the object.

Overrides:
copyTo in class DataDocument
Parameters:
destObject - The destination object to copy to.
deepCopy - true to use deep copy, false to use shallow.

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.

Overrides:
createMember in class DataDocument

endElement

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

For internal use only.

Overrides:
endElement in class DataDocument

getMajorVersion

public int getMajorVersion()
Description copied from interface: IReportDocument

Returns the major version number of the report's format.

Specified by:
getMajorVersion in interface IReportDocument
Returns:
The major version number as an int.

getMinorVersion

public int getMinorVersion()
Description copied from interface: IReportDocument

Returns the minor version number of the report's format.

Specified by:
getMinorVersion in interface IReportDocument
Returns:
The minor version number as an int.

getReportDefinition

public ReportDefinition getReportDefinition()
Description copied from interface: IReportDocument

Returns IReportDefinition, which contains areas, sections, and report objects in the report. This object provides access to areas in the report; each area may contain multiple sections, and each section may contain multiple report objects. A new report, by default, contains five area objects: the Report Header area, the Page Header area, the Details area, the Report Footer area, and the Page Footer area.

Specified by:
getReportDefinition in interface IReportDocument
Returns:
The ReportDefinition object.

getReportOptions

public IReportOptions getReportOptions()
Description copied from interface: IReportDocument

Returns IReportOptions. Use IReportOptions to modify the report's behavior and capabilities such as how it should handle server data, dates, queries, printing, viewing, and other such options.

Specified by:
getReportOptions in interface IReportDocument
Returns:
IReportOptions as an object.

getPrintOptions

public IPrintOptions getPrintOptions()

For internal use only.


getSummaryInfo

public ISummaryInfo getSummaryInfo()
Description copied from interface: IReportDocument

Returns the report's summary information. The summary information consists of the author's name, comments, keywords, subject, title, and whether or not a preview image is saved.

Specified by:
getSummaryInfo in interface IReportDocument
Returns:
The ISummaryInfo object.

hasContent

public boolean hasContent(java.lang.Object obj)

Returns whether or not an object has content.

Overrides:
hasContent in class DataDocument
Parameters:
obj - The object to check for content.
Returns:
true if the object has content, otherwise false.

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.

Overrides:
readElement in class DataDocument

save

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

For internal use only.

Overrides:
save in class DataDocument
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.

Overrides:
save in class DataDocument
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Overrides:
saveContents in class DataDocument
Throws:
java.io.IOException

setMajorVersion

public void setMajorVersion(int majorVersion)
Description copied from interface: IReportDocument

Sets the major version number of the report's format.

Specified by:
setMajorVersion in interface IReportDocument
Parameters:
majorVersion - The major version number as an int.

setMinorVersion

public void setMinorVersion(int minorVersion)
Description copied from interface: IReportDocument

Sets the minor version number of the report's format.

Specified by:
setMinorVersion in interface IReportDocument
Parameters:
minorVersion - The minor version number as an int.

setReportDefinition

public void setReportDefinition(IReportDefinition reportDef)
Description copied from interface: IReportDocument

Sets IReportDefinition, which contains areas, sections, and report objects in the report. This property provides access to areas in the report; each area may contain multiple sections, and each section may contain multiple report objects. A new report, by default, contains five area objects: the Report Header area, the Page Header area, the Details area, the Report Footer area, and the Page Footer area.

Specified by:
setReportDefinition in interface IReportDocument
Parameters:
reportDef - The ReportDefinition object.

setReportOptions

public void setReportOptions(IReportOptions reportOptions)
Description copied from interface: IReportDocument

Sets IReportOptions. Use IReportOptions to modify the report's behavior and capabilities such as how it should handle server data, dates, queries, printing, viewing, and other such options.

Specified by:
setReportOptions in interface IReportDocument
Parameters:
reportOptions - The IReportOptions object.

setPrintOptions

public void setPrintOptions(IPrintOptions printOptions)

For internal use only.


setSummaryInfo

public void setSummaryInfo(ISummaryInfo summaryInfo)
Description copied from interface: IReportDocument

Sets the report's summary information. The summary information consists of the author's name, comments, keywords, subject, title, and whether or not a preview image is saved.

Specified by:
setSummaryInfo in interface IReportDocument
Parameters:
summaryInfo - The ISummaryInfo object.

startElement

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

For internal use only.

Overrides:
startElement in class DataDocument

doControllerModification

public void doControllerModification(java.lang.Object newObject)
Overrides:
doControllerModification in class DataDocument

isDirectlyControllable

public boolean isDirectlyControllable()
Overrides:
isDirectlyControllable in class DataDocument

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
Overrides:
enumerateMembers in class DataDocument