com.businessobjects.enterprise.crystalreport
Interface CrystalReport

All Superinterfaces:

InfoObject

public interface CrystalReport
extends InfoObject

Provides basic information about a report.

The report class allows you to refresh its properties and retrieve its thumbnail. It can also be used to gather and set processing information on a report, or a report instance, before or after running the report. Furthermore, you also have the option to use the hyperlinking feature which allows you to navigate through published reports.

Nested Class Summary

static class

CrystalReport.Factory A class with methods for creating instances of the CrystalReport type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

AnalyticActivities	addNewAnalyticActivities() Internal Use Only.
BusinessViews	addNewBusinessViews() Appends and returns a new empty BusinessViews object to the last element of the array.
CorporateCategories	addNewCorporateCategories() Appends and returns a new empty CorporateCategories object to the last element of the array.
CustomProperties	addNewCustomProperties() Appends and returns a new empty CustomProperties object to the last element of the array.
EncyclopediaTopics	addNewEncyclopediaTopics() Internal Use Only.
FileProperties	addNewFileProperties() Adds a new FileProperties object to the last element of the array.
HyperlinkResolves	addNewHyperlinkResolves() Appends and returns a new empty HyperlinkResolves object to the last element of the array.
PersonalCategories	addNewPersonalCategories() Appends and returns a new empty PersonalCategories object to the last element of the array.
ReportProcessingInfo	addNewPluginProcessingInterface() Appends and returns a new empty ReportProcessingInterface object to last element of the array.
ReportRefreshOptions	addNewReportRefreshOptions() Appends and returns a new empty ReportRefreshOptions object to the last element of the array.
SchedulingInfo	addNewSchedulingInfo() Appends and returns a new empty SchedulingInfo object to the last element of the array.
Universes	addNewUniverses() Internal Use Only.
AnalyticActivities	getAnalyticActivities() Internal Use Only.
BusinessViews	getBusinessViews() Gets a collection of Business View IDs that have been assigned to this report.
CorporateCategories	getCorporateCategories() Returns the ID set of top-level categories that have been assigned to the object.
CustomProperties	getCustomProperties() Returns the custom properties.
EncyclopediaTopics	getEncyclopediaTopics() Internal Use Only.
FileProperties	getFileProperties() Returns the files associated with InfoObject.
HyperlinkResolves	getHyperlinkResolves() Returns a HyperlinkResolves collection.
java.lang.String	getMimeType() Internal Use Only.
PersonalCategories	getPersonalCategories() Returns the ID set of top-level personal categories that have been assigned to the object.
ReportProcessingInfo	getPluginProcessingInterface() Returns the report properties.
java.lang.String	getProcessingProgID() Internal Use Only.
ReportRefreshOptions	getReportRefreshOptions() Specifies the report refresh options.
SchedulingInfo	getSchedulingInfo() Returns the scheduling information for the object.
Universes	getUniverses() Internal Use Only.
java.lang.String	getViewerURL() Returns the viewer URL associated with an alert that will be included in the alert notification email.
boolean	isSetAnalyticActivities() Internal Use Only.
boolean	isSetBusinessViews() Checks if the Business View IDs have been set.
boolean	isSetCorporateCategories() Checks if the CorporateCategories have been set.
boolean	isSetCustomProperties() Checks if the custom properties has been set.
boolean	isSetEncyclopediaTopics() Internal Use Only.
boolean	isSetFileProperties() Checks if the FileProperties have been set.
boolean	isSetHyperlinkResolves() Checks if the HyperlinkResolves have been set.
boolean	isSetMimeType() Internal Use Only.
boolean	isSetPersonalCategories() Checks if the PersonalCategories have been set.
boolean	isSetPluginProcessingInterface() Checks if the PluginProcessingInterface has been set.
boolean	isSetProcessingProgID() Internal Use Only.
boolean	isSetReportRefreshOptions() Checks if the report refresh options have been set.
boolean	isSetSchedulingInfo() Checks if the SchedulingInfo has been set.
boolean	isSetUniverses() Internal Use Only.
boolean	isSetViewerURL() Checks if the ViewerURL has been set.
void	setAnalyticActivities(AnalyticActivities analyticActivities) Internal Use Only.
void	setBusinessViews(BusinessViews businessViews) Sets a collection of BusinessView IDs that have been assigned to this report.
void	setCorporateCategories(CorporateCategories corporateCategories) Sets the ID set of top-level categories.
void	setCustomProperties(CustomProperties customProperties) Sets the custom properties.
void	setEncyclopediaTopics(EncyclopediaTopics encyclopediaTopics) Internal Use Only.
void	setFileProperties(FileProperties fileProperties) Sets the files associated with InfoObject.
void	setHyperlinkResolves(HyperlinkResolves hyperlinkResolves) Sets a HyperlinkResolves collection.
void	setMimeType(java.lang.String mimeType) Internal Use Only.
void	setPersonalCategories(PersonalCategories personalCategories) Sets the ID set of top-level personal categories.
void	setPluginProcessingInterface(ReportProcessingInfo pluginProcessingInterface) Sets the report properties.
void	setProcessingProgID(java.lang.String processingProgID) Internal Use Only.
void	setReportRefreshOptions(ReportRefreshOptions reportRefreshOptions) Specifies the report refresh options.
void	setSchedulingInfo(SchedulingInfo schedulingInfo) Sets the scheduling information for the object.
void	setUniverses(Universes universes) Internal Use Only.
void	setViewerURL(java.lang.String viewerURL) Sets the viewer URL associated with an alert that will be included in the alert notification email.
void	unsetAnalyticActivities() Internal Use Only.
void	unsetBusinessViews() Deletes or unsets the BusinessViews element.
void	unsetCorporateCategories() Deletes or unsets the CorporateCategories element.
void	unsetCustomProperties() Deletes or unsets the CustomProperties element.
void	unsetEncyclopediaTopics() Internal Use Only.
void	unsetFileProperties() Deletes or unsets the FileProperties element.
void	unsetHyperlinkResolves() Deletes or unsets the HyperlinkResolves element.
void	unsetMimeType() Internal Use Only.
void	unsetPersonalCategories() Deletes or unsets the PersonalCategories element.
void	unsetPluginProcessingInterface() Deletes or unsets the PluginProcessingInterface element.
void	unsetProcessingProgID() Internal Use Only.
void	unsetReportRefreshOptions() Deletes or unsets the report refresh options element.
void	unsetSchedulingInfo() Deletes or unsets the SchedulingInfo element.
void	unsetUniverses() Internal Use Only.
void	unsetViewerURL() Deletes or unsets the ViewerURL element.
org.apache.xmlbeans.XmlString	xgetMimeType() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetProcessingProgID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetViewerURL() Internal Use Only.
void	xsetMimeType(org.apache.xmlbeans.XmlString mimeType) Internal Use Only.
void	xsetProcessingProgID(org.apache.xmlbeans.XmlString processingProgID) Internal Use Only.
void	xsetViewerURL(org.apache.xmlbeans.XmlString viewerURL) Internal Use Only.

Methods inherited from interface com.businessobjects.enterprise.infoobject.InfoObject

addNewAlerts, addNewPluginInfo, addNewRolesOnObject, addNewSecurityInfo, addNewSecurityInfo2, addNewSharedDoc, addNewStatusInfo, getAlerts, getChildrenObjects, getCreationTime, getCUID, getDescription, getEndTime, getErrorMessage, getID, getInstance, getInstanceObject, getIsApplicationObject, getIsComponent, getIsHiddenObject, getIsPluginObject, getIsRecurring, getIsRunnableObject, getIsSendable, getIsSystemObject, getKey, getKeywords, getKind, getLastRunTime, getLastSuccessfulInstanceCUID, getName, getNewJobID, getNextRunTime, getObjectIsContainer, getOwner, getOwnerCUID, getParentCUID, getPluginInfo, getRolesOnObject, getRUID, getSchedulable, getSecurityInfo, getSecurityInfo2, getSharedDoc, getStartTime, getStatusInfo, getUiStatus, getUpdateTime, isSetAlerts, isSetChildrenObjects, isSetCreationTime, isSetCUID, isSetDescription, isSetEndTime, isSetErrorMessage, isSetID, isSetInstance, isSetInstanceObject, isSetIsApplicationObject, isSetIsComponent, isSetIsHiddenObject, isSetIsPluginObject, isSetIsRecurring, isSetIsRunnableObject, isSetIsSendable, isSetIsSystemObject, isSetKey, isSetKeywords, isSetKind, isSetLastRunTime, isSetLastSuccessfulInstanceCUID, isSetNewJobID, isSetNextRunTime, isSetObjectIsContainer, isSetOwner, isSetOwnerCUID, isSetParentCUID, isSetPluginInfo, isSetRolesOnObject, isSetRUID, isSetSchedulable, isSetSecurityInfo, isSetSecurityInfo2, isSetSharedDoc, isSetStartTime, isSetStatusInfo, isSetUiStatus, isSetUpdateTime, setAlerts, setChildrenObjects, setCreationTime, setCUID, setDescription, setEndTime, setErrorMessage, setID, setInstance, setInstanceObject, setIsApplicationObject, setIsComponent, setIsHiddenObject, setIsPluginObject, setIsRecurring, setIsRunnableObject, setIsSendable, setIsSystemObject, setKey, setKeywords, setKind, setLastRunTime, setLastSuccessfulInstanceCUID, setName, setNewJobID, setNextRunTime, setObjectIsContainer, setOwner, setOwnerCUID, setParentCUID, setPluginInfo, setRolesOnObject, setRUID, setSchedulable, setSecurityInfo, setSecurityInfo2, setSharedDoc, setStartTime, setStatusInfo, setUiStatus, setUpdateTime, unsetAlerts, unsetChildrenObjects, unsetCreationTime, unsetCUID, unsetDescription, unsetEndTime, unsetErrorMessage, unsetID, unsetInstance, unsetInstanceObject, unsetIsApplicationObject, unsetIsComponent, unsetIsHiddenObject, unsetIsPluginObject, unsetIsRecurring, unsetIsRunnableObject, unsetIsSendable, unsetIsSystemObject, unsetKey, unsetKeywords, unsetKind, unsetLastRunTime, unsetLastSuccessfulInstanceCUID, unsetNewJobID, unsetNextRunTime, unsetObjectIsContainer, unsetOwner, unsetOwnerCUID, unsetParentCUID, unsetPluginInfo, unsetRolesOnObject, unsetRUID, unsetSchedulable, unsetSecurityInfo, unsetSecurityInfo2, unsetSharedDoc, unsetStartTime, unsetStatusInfo, unsetUiStatus, unsetUpdateTime, xgetChildrenObjects, xgetCreationTime, xgetCUID, xgetDescription, xgetEndTime, xgetErrorMessage, xgetID, xgetInstance, xgetInstanceObject, xgetIsApplicationObject, xgetIsComponent, xgetIsHiddenObject, xgetIsPluginObject, xgetIsRecurring, xgetIsRunnableObject, xgetIsSendable, xgetIsSystemObject, xgetKey, xgetKeywords, xgetKind, xgetLastRunTime, xgetLastSuccessfulInstanceCUID, xgetName, xgetNewJobID, xgetNextRunTime, xgetObjectIsContainer, xgetOwner, xgetOwnerCUID, xgetParentCUID, xgetRUID, xgetSchedulable, xgetStartTime, xgetUiStatus, xgetUpdateTime, xsetChildrenObjects, xsetCreationTime, xsetCUID, xsetDescription, xsetEndTime, xsetErrorMessage, xsetID, xsetInstance, xsetInstanceObject, xsetIsApplicationObject, xsetIsComponent, xsetIsHiddenObject, xsetIsPluginObject, xsetIsRecurring, xsetIsRunnableObject, xsetIsSendable, xsetIsSystemObject, xsetKey, xsetKeywords, xsetKind, xsetLastRunTime, xsetLastSuccessfulInstanceCUID, xsetName, xsetNewJobID, xsetNextRunTime, xsetObjectIsContainer, xsetOwner, xsetOwnerCUID, xsetParentCUID, xsetRUID, xsetSchedulable, xsetStartTime, xsetUiStatus, xsetUpdateTime

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getMimeType

java.lang.String getMimeType()

Internal Use Only.

xgetMimeType

org.apache.xmlbeans.XmlString xgetMimeType()

Internal Use Only.

isSetMimeType

boolean isSetMimeType()

Internal Use Only.

setMimeType

void setMimeType(java.lang.String mimeType)

Internal Use Only.

xsetMimeType

void xsetMimeType(org.apache.xmlbeans.XmlString mimeType)

Internal Use Only.

unsetMimeType

void unsetMimeType()

Internal Use Only.

getSchedulingInfo

SchedulingInfo getSchedulingInfo()

Returns the scheduling information for the object. It will be an empty reference if the object does not support scheduling.

Returns:

A SchedulingInfo object containing this object's scheduling information.

isSetSchedulingInfo

boolean isSetSchedulingInfo()

Checks if the SchedulingInfo has been set.

Returns:

true if the SchedulingInfo element has been set, otherwise false.

setSchedulingInfo

void setSchedulingInfo(SchedulingInfo schedulingInfo)

Sets the scheduling information for the object.

Parameters:

schedulingInfo - A SchedulingInfo object containing this object's scheduling information.

addNewSchedulingInfo

SchedulingInfo addNewSchedulingInfo()

Appends and returns a new empty SchedulingInfo object to the last element of the array.

Returns:

A new SchedulingInfo.

unsetSchedulingInfo

void unsetSchedulingInfo()

Deletes or unsets the SchedulingInfo element.

getFileProperties

FileProperties getFileProperties()

Returns the files associated with InfoObject.

Returns:

The files associated with InfoObject.

isSetFileProperties

boolean isSetFileProperties()

Checks if the FileProperties have been set.

Returns:

true if the FileProperties element has been set, otherwise false.

setFileProperties

void setFileProperties(FileProperties fileProperties)

Sets the files associated with InfoObject.

Parameters:

fileProperties - The files associated with InfoObject.

addNewFileProperties

FileProperties addNewFileProperties()

Adds a new FileProperties object to the last element of the array.

Returns:

A new FileProperties.

unsetFileProperties

void unsetFileProperties()

Deletes or unsets the FileProperties element.

getReportRefreshOptions

ReportRefreshOptions getReportRefreshOptions()

Specifies the report refresh options.

Returns:

Specifies the report refresh options.

isSetReportRefreshOptions

boolean isSetReportRefreshOptions()

Checks if the report refresh options have been set.

Returns:

true if the ReportRefreshOptions element has been set, otherwise false.

setReportRefreshOptions

void setReportRefreshOptions(ReportRefreshOptions reportRefreshOptions)

Specifies the report refresh options.

Parameters:

reportRefreshOptions - Specifies the report refresh options.

addNewReportRefreshOptions

ReportRefreshOptions addNewReportRefreshOptions()

Appends and returns a new empty ReportRefreshOptions object to the last element of the array.

Returns:

A new ReportRefreshOptions.

unsetReportRefreshOptions

void unsetReportRefreshOptions()

Deletes or unsets the report refresh options element.

getCorporateCategories

CorporateCategories getCorporateCategories()

Returns the ID set of top-level categories that have been assigned to the object.

Returns:

A set of category IDs that have been assigned to the object.

isSetCorporateCategories

boolean isSetCorporateCategories()

Checks if the CorporateCategories have been set.

Returns:

true if the CorporateCategories element has been set, otherwise false.

setCorporateCategories

void setCorporateCategories(CorporateCategories corporateCategories)

Sets the ID set of top-level categories.

Parameters:

corporateCategories - A set of category IDs that have been assigned to the object.

addNewCorporateCategories

CorporateCategories addNewCorporateCategories()

Appends and returns a new empty CorporateCategories object to the last element of the array.

Returns:

A new CorporateCategories.

unsetCorporateCategories

void unsetCorporateCategories()

Deletes or unsets the CorporateCategories element.

getPersonalCategories

PersonalCategories getPersonalCategories()

Returns the ID set of top-level personal categories that have been assigned to the object.

Returns:

A set of category IDs that have been assigned to the object.

isSetPersonalCategories

boolean isSetPersonalCategories()

Checks if the PersonalCategories have been set.

Returns:

true if the PersonalCategories element has been set, otherwise false.

setPersonalCategories

void setPersonalCategories(PersonalCategories personalCategories)

Sets the ID set of top-level personal categories.

Parameters:

personalCategories - A set of category IDs that have been assigned to the object.

addNewPersonalCategories

PersonalCategories addNewPersonalCategories()

Appends and returns a new empty PersonalCategories object to the last element of the array.

Returns:

A new PersonalCategories.

unsetPersonalCategories

void unsetPersonalCategories()

Deletes or unsets the PersonalCategories element.

getEncyclopediaTopics

EncyclopediaTopics getEncyclopediaTopics()

Internal Use Only.

isSetEncyclopediaTopics

boolean isSetEncyclopediaTopics()

Internal Use Only.

setEncyclopediaTopics

void setEncyclopediaTopics(EncyclopediaTopics encyclopediaTopics)

Internal Use Only.

addNewEncyclopediaTopics

EncyclopediaTopics addNewEncyclopediaTopics()

Internal Use Only.

unsetEncyclopediaTopics

void unsetEncyclopediaTopics()

Internal Use Only.

getAnalyticActivities

AnalyticActivities getAnalyticActivities()

Internal Use Only.

isSetAnalyticActivities

boolean isSetAnalyticActivities()

Internal Use Only.

setAnalyticActivities

void setAnalyticActivities(AnalyticActivities analyticActivities)

Internal Use Only.

addNewAnalyticActivities

AnalyticActivities addNewAnalyticActivities()

Internal Use Only.

unsetAnalyticActivities

void unsetAnalyticActivities()

Internal Use Only.

getBusinessViews

BusinessViews getBusinessViews()

Gets a collection of Business View IDs that have been assigned to this report.

Returns:

A collection of Business View IDs that have been assigned to this report.

isSetBusinessViews

boolean isSetBusinessViews()

Checks if the Business View IDs have been set.

Returns:

true if the BusinessViews element has been set, otherwise false.

setBusinessViews

void setBusinessViews(BusinessViews businessViews)

Sets a collection of BusinessView IDs that have been assigned to this report.

Parameters:

businessViews - A collection of BusinessView IDs that have been assigned to this report.

addNewBusinessViews

BusinessViews addNewBusinessViews()

Appends and returns a new empty BusinessViews object to the last element of the array.

Returns:

A new BusinessViews.

unsetBusinessViews

void unsetBusinessViews()

Deletes or unsets the BusinessViews element.

getUniverses

Universes getUniverses()

Internal Use Only.

isSetUniverses

boolean isSetUniverses()

Internal Use Only.

setUniverses

void setUniverses(Universes universes)

Internal Use Only.

addNewUniverses

Universes addNewUniverses()

Internal Use Only.

unsetUniverses

void unsetUniverses()

Internal Use Only.

getPluginProcessingInterface

ReportProcessingInfo getPluginProcessingInterface()

Returns the report properties.

Returns:

The report properties.

isSetPluginProcessingInterface

boolean isSetPluginProcessingInterface()

Checks if the PluginProcessingInterface has been set.

Returns:

true if the PluginProcessingInterface element has been set, otherwise false.

setPluginProcessingInterface

void setPluginProcessingInterface(ReportProcessingInfo pluginProcessingInterface)

Sets the report properties.

Parameters:

pluginProcessingInterface - The report properties.

addNewPluginProcessingInterface

ReportProcessingInfo addNewPluginProcessingInterface()

Appends and returns a new empty ReportProcessingInterface object to last element of the array.

Returns:

A new ReportProcessingInfo.

unsetPluginProcessingInterface

void unsetPluginProcessingInterface()

Deletes or unsets the PluginProcessingInterface element.

getProcessingProgID

java.lang.String getProcessingProgID()

Internal Use Only.

xgetProcessingProgID

org.apache.xmlbeans.XmlString xgetProcessingProgID()

Internal Use Only.

isSetProcessingProgID

boolean isSetProcessingProgID()

Internal Use Only.

setProcessingProgID

void setProcessingProgID(java.lang.String processingProgID)

Internal Use Only.

xsetProcessingProgID

void xsetProcessingProgID(org.apache.xmlbeans.XmlString processingProgID)

Internal Use Only.

unsetProcessingProgID

void unsetProcessingProgID()

Internal Use Only.

getViewerURL

java.lang.String getViewerURL()

Returns the viewer URL associated with an alert that will be included in the alert notification email. The URL is a link to the report that contains the triggered alert. This URL should contain the HTTP protocol, the web server name, the web server virtual path, the name of the JSP page used to view the report, and the report ID (or some other property that identifies the report, such as the report name). For example:
http://server/viewer.jsp?id=%SI_ID%

Note: The percentage signs around the property name indicate that a variable is being used; the Enterprise system will substitute the property name with the appropriate value (for example, the ID of a specific report).

Returns:

A String containing the viewer URL associated with an alert that will be included in the alert notification email.

xgetViewerURL

org.apache.xmlbeans.XmlString xgetViewerURL()

Internal Use Only.

isSetViewerURL

boolean isSetViewerURL()

Checks if the ViewerURL has been set.

Returns:

true if the ViewerURL element has been set, otherwise false.

setViewerURL

void setViewerURL(java.lang.String viewerURL)

Sets the viewer URL associated with an alert that will be included in the alert notification email. The URL is a link to the report that contains the triggered alert. This URL should contain the HTTP protocol, the web server name, the web server virtual path, the name of the JSP page used to view the report, and the report ID (or some other property that identifies the report, such as the report name). For example:
http://server/viewer.jsp?id=%SI_ID%. or %SI_VIEWER_URL%

Note: The percentage signs around the property name indicate that a variable is being used; the Enterprise system will substitute the property name with the appropriate value (for example, the ID of a specific report).

Parameters:

viewerURL - A String containing the viewer URL associated with an alert that will be included in the alert notification email.

xsetViewerURL

void xsetViewerURL(org.apache.xmlbeans.XmlString viewerURL)

Internal Use Only.

unsetViewerURL

void unsetViewerURL()

Deletes or unsets the ViewerURL element.

getHyperlinkResolves

HyperlinkResolves getHyperlinkResolves()

Returns a HyperlinkResolves collection.

Returns:

A HyperlinkResolves collection.

isSetHyperlinkResolves

boolean isSetHyperlinkResolves()

Checks if the HyperlinkResolves have been set.

Returns:

true if the ViewerURL element has been set, otherwise false.

setHyperlinkResolves

void setHyperlinkResolves(HyperlinkResolves hyperlinkResolves)

Sets a HyperlinkResolves collection.

Parameters:

hyperlinkResolves - A HyperlinkResolves collection.

addNewHyperlinkResolves

HyperlinkResolves addNewHyperlinkResolves()

Appends and returns a new empty HyperlinkResolves object to the last element of the array.

Returns:

A new HyperlinkResolves.

unsetHyperlinkResolves

void unsetHyperlinkResolves()

Deletes or unsets the HyperlinkResolves element.

getCustomProperties

CustomProperties getCustomProperties()

Returns the custom properties.

Returns:

The custom properties.

isSetCustomProperties

boolean isSetCustomProperties()

Checks if the custom properties has been set.

Returns:

true if the CustomProperties element has been set, otherwise false.

setCustomProperties

void setCustomProperties(CustomProperties customProperties)

Sets the custom properties.

Parameters:

customProperties - The custom properties.

addNewCustomProperties

CustomProperties addNewCustomProperties()

Appends and returns a new empty CustomProperties object to the last element of the array.

Returns:

A new CustomProperties.

unsetCustomProperties

void unsetCustomProperties()

Deletes or unsets the CustomProperties element.