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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.document.SummaryInfo
All Implemented Interfaces:
ISummaryInfo, IClone

public class SummaryInfo
extends java.lang.Object
implements ISummaryInfo, IClone

This object enables you to get and set summary information for the report. This information includes: the author of the document, the document's subject, the document title, any comments the author of the report has added, keywords that describe the report, and whether or not a thumbnail image of the report is saved.

Example:

This sample shows how to update the summary information of a report. Summary information of a report can contain the author's name, comments, keywords, subject, title, and whether a preview image is saved.

 ISummaryInfo summaryInfo = clientDoc.getReportDocument().getSummaryInfo();
 ISummaryInfo newSummaryInfo = summaryInfo.clone(true);
 newSummaryInfo.setAuthor( "Leo Tolstoy" );
 clientDoc.modifySummaryInfo( newSummaryInfo );
 


Constructor Summary
SummaryInfo()
           
SummaryInfo(ISummaryInfo 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, 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)
           
 java.lang.String getAuthor()
          Returns the author's name.
 java.lang.String getComments()
          Returns any comments the author of the report has added.
 ControllableMixin getControllableMixin()
           
 boolean getIsSavingWithPreview()
          Returns whether or not a thumbnail image of the report is to be saved.
 java.lang.String getKeywords()
          Returns keywords that have been assigned to describe the report.
 java.lang.String getSubject()
          Returns the subject that has been assigned to the report.
 java.lang.String getTitle()
          Returns the title of the report.
 boolean hasContent(java.lang.Object srcSummaryInfo)
           
 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(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
          For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setAuthor(java.lang.String author)
          Sets the author's name.
 void setComments(java.lang.String comments)
          Sets comments for the report.
 void setIsSavingWithPreview(boolean isSavingWithPreview)
          Set whether or not a thumbnail image of the report is to be saved.
 void setKeywords(java.lang.String keywords)
          Sets keywords to describe the report.
 void setSubject(java.lang.String subject)
          Sets the subject for the report.
 void setTitle(java.lang.String title)
          Sets the title of the report.
 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

SummaryInfo

public SummaryInfo(ISummaryInfo src)

SummaryInfo

public SummaryInfo()
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,
                                     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.


getAuthor

public java.lang.String getAuthor()
Description copied from interface: ISummaryInfo

Returns the author's name.

Specified by:
getAuthor in interface ISummaryInfo
Returns:
The author's name as a String.

getComments

public java.lang.String getComments()
Description copied from interface: ISummaryInfo

Returns any comments the author of the report has added.

Specified by:
getComments in interface ISummaryInfo
Returns:
The comments as a String.

getIsSavingWithPreview

public boolean getIsSavingWithPreview()
Description copied from interface: ISummaryInfo

Returns whether or not a thumbnail image of the report is to be saved.

Specified by:
getIsSavingWithPreview in interface ISummaryInfo
Returns:
true if a preview is saved, and false otherwise.

getKeywords

public java.lang.String getKeywords()
Description copied from interface: ISummaryInfo

Returns keywords that have been assigned to describe the report.

Specified by:
getKeywords in interface ISummaryInfo
Returns:
The keywords as a String.

getSubject

public java.lang.String getSubject()
Description copied from interface: ISummaryInfo

Returns the subject that has been assigned to the report.

Specified by:
getSubject in interface ISummaryInfo
Returns:
The subject as a String.

getTitle

public java.lang.String getTitle()
Description copied from interface: ISummaryInfo

Returns the title of the report. This is not the same as the report's file name.

Specified by:
getTitle in interface ISummaryInfo
Returns:
The title as a String.

hasContent

public boolean hasContent(java.lang.Object srcSummaryInfo)

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(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

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

For internal use only.

Throws:
java.io.IOException

saveContents

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

For internal use only.

Throws:
java.io.IOException

setAuthor

public void setAuthor(java.lang.String author)
Description copied from interface: ISummaryInfo

Sets the author's name.

Specified by:
setAuthor in interface ISummaryInfo
Parameters:
author - The author's name as a String.

setComments

public void setComments(java.lang.String comments)
Description copied from interface: ISummaryInfo

Sets comments for the report.

Specified by:
setComments in interface ISummaryInfo
Parameters:
comments - The comments as a String.

setIsSavingWithPreview

public void setIsSavingWithPreview(boolean isSavingWithPreview)
Description copied from interface: ISummaryInfo

Set whether or not a thumbnail image of the report is to be saved.

Specified by:
setIsSavingWithPreview in interface ISummaryInfo
Parameters:
isSavingWithPreview - true if a preview is saved, and false otherwise.

setKeywords

public void setKeywords(java.lang.String keywords)
Description copied from interface: ISummaryInfo

Sets keywords to describe the report.

Specified by:
setKeywords in interface ISummaryInfo
Parameters:
keywords - The keywords as a String.

setSubject

public void setSubject(java.lang.String subject)
Description copied from interface: ISummaryInfo

Sets the subject for the report.

Specified by:
setSubject in interface ISummaryInfo
Parameters:
subject - The subject as a String.

setTitle

public void setTitle(java.lang.String title)
Description copied from interface: ISummaryInfo

Sets the title of the report. This is not the same as the report's file name.

Specified by:
setTitle in interface ISummaryInfo
Parameters:
title - The title as a String.

startElement

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

For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)
                              throws ReportSDKException
Throws:
ReportSDKException

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)