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

All Superinterfaces:
IClone
All Known Implementing Classes:
SummaryInfo

public interface ISummaryInfo
extends IClone

This interface 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.


Method Summary
 java.lang.String getAuthor()
          Returns the author's name.
 java.lang.String getComments()
          Returns any comments the author of the report has added.
 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.
 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.
 

Method Detail

getAuthor

java.lang.String getAuthor()

Returns the author's name.

Returns:
The author's name as a String.

getComments

java.lang.String getComments()

Returns any comments the author of the report has added.

Returns:
The comments as a String.

getIsSavingWithPreview

boolean getIsSavingWithPreview()

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

Returns:
true if a preview is saved, and false otherwise.

getKeywords

java.lang.String getKeywords()

Returns keywords that have been assigned to describe the report.

Returns:
The keywords as a String.

getSubject

java.lang.String getSubject()

Returns the subject that has been assigned to the report.

Returns:
The subject as a String.

getTitle

java.lang.String getTitle()

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

Returns:
The title as a String.

setAuthor

void setAuthor(java.lang.String author)

Sets the author's name.

Parameters:
author - The author's name as a String.

setComments

void setComments(java.lang.String comments)

Sets comments for the report.

Parameters:
comments - The comments as a String.

setIsSavingWithPreview

void setIsSavingWithPreview(boolean isSavingWithPreview)

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

Parameters:
isSavingWithPreview - true if a preview is saved, and false otherwise.

setKeywords

void setKeywords(java.lang.String keywords)

Sets keywords to describe the report.

Parameters:
keywords - The keywords as a String.

setSubject

void setSubject(java.lang.String subject)

Sets the subject for the report.

Parameters:
subject - The subject as a String.

setTitle

void setTitle(java.lang.String title)

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

Parameters:
title - The title as a String.