com.businessobjects.enterprise.rtf
Interface Rtf

All Superinterfaces:

InfoObject

public interface Rtf
extends InfoObject

This class represents an RTF formatted report.

Nested Class Summary

static interface	Rtf.EpmDocuments Internal Use Only.
static class	Rtf.Factory A class with methods for creating instances of the Rtf type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

AnalyticActivities	addNewAnalyticActivities() Appends and returns a new empty AnalyticActivities object.
CorporateCategories	addNewCorporateCategories() Appends and returns a new empty CorporateCategories object.
CustomProperties	addNewCustomProperties() Appends and returns a new empty CustomProperties element
EncyclopediaTopics	addNewEncyclopediaTopics() Internal Use Only.
Rtf.EpmDocuments	addNewEpmDocuments() Internal Use Only.
FileProperties	addNewFileProperties() Appends and returns a new empty FileProperties object.
PersonalCategories	addNewPersonalCategories() Appends and returns a new empty PersonalCategories object.
ReportProcessingInfo	addNewPluginProcessingInterface() Internal Use Only.
SchedulingInfo	addNewSchedulingInfo() Appends and returns a new empty SchedulingInfo object.
AnalyticActivities	getAnalyticActivities() Returns the AnalyticActivities element.
CorporateCategories	getCorporateCategories() Returns the ID set of top-level categories that have been assigned to the object.
CustomProperties	getCustomProperties() Returns the custom properties.
java.lang.String	getE65Cuid() Internal Use Only.
java.lang.String	getE65Id() Internal Use Only.
EncyclopediaTopics	getEncyclopediaTopics() Internal Use Only.
Rtf.EpmDocuments	getEpmDocuments() Internal Use Only.
FileProperties	getFileProperties() Returns the InfoObject's associated files.
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() Internal Use Only.
java.lang.String	getProcessingProgID() Internal Use Only.
SchedulingInfo	getSchedulingInfo() Returns the scheduling information for the object.
java.lang.String	getUpdateObject() 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() Checks if the AnalyticActivities element has been set.
boolean	isSetCorporateCategories() Checks if the ID set of top-level categories that have been assigned to the object has been set.
boolean	isSetCustomProperties() Checks if the custom properties have been set.
boolean	isSetE65Cuid() Internal Use Only.
boolean	isSetE65Id() Internal Use Only.
boolean	isSetEncyclopediaTopics() Internal Use Only.
boolean	isSetEpmDocuments() Internal Use Only.
boolean	isSetFileProperties() Checks if the InfoObject's associated files have been set.
boolean	isSetMimeType() Internal Use Only.
boolean	isSetPersonalCategories() Checks if the ID set of top-level personal categories that have been assigned to the object has been set.
boolean	isSetPluginProcessingInterface() Internal Use Only.
boolean	isSetProcessingProgID() Internal Use Only.
boolean	isSetSchedulingInfo() Checks if the scheduling information for the object has been set.
boolean	isSetUpdateObject() Internal Use Only.
boolean	isSetViewerURL() Checks if the viewer URL associated with an alert that will be included in the alert notification email has been set.
void	setAnalyticActivities(AnalyticActivities analyticActivities) Sets the AnalyticActivities element.
void	setCorporateCategories(CorporateCategories corporateCategories) Sets the ID set of top-level categories.
void	setCustomProperties(CustomProperties customProperties) Sets the custom properties.
void	setE65Cuid(java.lang.String e65Cuid) Internal Use Only.
void	setE65Id(java.lang.String e65Id) Internal Use Only.
void	setEncyclopediaTopics(EncyclopediaTopics encyclopediaTopics) Internal Use Only.
void	setEpmDocuments(Rtf.EpmDocuments epmDocuments) Internal Use Only.
void	setFileProperties(FileProperties fileProperties) Sets the InfoObject's associated files.
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) Internal Use Only.
void	setProcessingProgID(java.lang.String processingProgID) Internal Use Only.
void	setSchedulingInfo(SchedulingInfo schedulingInfo) Sets the scheduling information for the object.
void	setUpdateObject(java.lang.String updateObject) 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() Deletes or unsets the AnalyticActivities element.
void	unsetCorporateCategories() Deletes or unsets the CorporateCategories element.
void	unsetCustomProperties() Deletes or unsets the CustomProperties element.
void	unsetE65Cuid() Internal Use Only.
void	unsetE65Id() Internal Use Only.
void	unsetEncyclopediaTopics() Internal Use Only.
void	unsetEpmDocuments() Internal Use Only.
void	unsetFileProperties() Deletes or unsets the FileProperties element.
void	unsetMimeType() Internal Use Only.
void	unsetPersonalCategories() Deletes or unsets the PersonalCategories element.
void	unsetPluginProcessingInterface() Internal Use Only.
void	unsetProcessingProgID() Internal Use Only.
void	unsetSchedulingInfo() Deletes or unsets the SchedulingInfo element.
void	unsetUpdateObject() Internal Use Only.
void	unsetViewerURL() Deletes or unsets the ViewerURL element.
org.apache.xmlbeans.XmlString	xgetE65Cuid() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetE65Id() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetMimeType() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetProcessingProgID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUpdateObject() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetViewerURL() Internal Use Only.
void	xsetE65Cuid(org.apache.xmlbeans.XmlString e65Cuid) Internal Use Only.
void	xsetE65Id(org.apache.xmlbeans.XmlString e65Id) Internal Use Only.
void	xsetMimeType(org.apache.xmlbeans.XmlString mimeType) Internal Use Only.
void	xsetProcessingProgID(org.apache.xmlbeans.XmlString processingProgID) Internal Use Only.
void	xsetUpdateObject(org.apache.xmlbeans.XmlString updateObject) 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 scheduling information for the object has been set.

Returns:

true if the scheduling information has been set, and false otherwise.

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.

Returns:

An empty SchedulingInfo object.

unsetSchedulingInfo

void unsetSchedulingInfo()

Deletes or unsets the SchedulingInfo element.

getFileProperties

FileProperties getFileProperties()

Returns the InfoObject's associated files.

Returns:

The InfoObject's associated files.

isSetFileProperties

boolean isSetFileProperties()

Checks if the InfoObject's associated files have been set.

Returns:

true if the associated files have been set, and false otherwise.

setFileProperties

void setFileProperties(FileProperties fileProperties)

Sets the InfoObject's associated files.

Parameters:

fileProperties - The InfoObject's associated files.

addNewFileProperties

FileProperties addNewFileProperties()

Appends and returns a new empty FileProperties object.

Returns:

An empty FileProperties object.

unsetFileProperties

void unsetFileProperties()

Deletes or unsets the FileProperties 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 ID set of top-level categories that have been assigned to the object has been set.

Returns:

true if the ID set of top-level categories has been set, and false otherwise.

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.

Returns:

An empty CorporateCategories object.

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 ID set of top-level personal categories that have been assigned to the object has been set.

Returns:

true if the ID set of top-level personal categories has been set, and false otherwise.

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.

Returns:

An empty PersonalCategories object.

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()

Returns the AnalyticActivities element.

Returns:

The AnalyticActivities element.

isSetAnalyticActivities

boolean isSetAnalyticActivities()

Checks if the AnalyticActivities element has been set.

Returns:

true if the AnalyticActivities element has been set, and false otherwise.

setAnalyticActivities

void setAnalyticActivities(AnalyticActivities analyticActivities)

Sets the AnalyticActivities element.

Parameters:

analyticActivities - The AnalyticActivities element.

addNewAnalyticActivities

AnalyticActivities addNewAnalyticActivities()

Appends and returns a new empty AnalyticActivities object.

Returns:

An empty AnalyticActivities object.

unsetAnalyticActivities

void unsetAnalyticActivities()

Deletes or unsets the AnalyticActivities element.

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 viewer URL associated with an alert that will be included in the alert notification email has been set.

Returns:

true if the viewer URL associated with an alert that will be included in the alert notification email has been set, and false otherwise.

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.

getE65Cuid

java.lang.String getE65Cuid()

Internal Use Only.

xgetE65Cuid

org.apache.xmlbeans.XmlString xgetE65Cuid()

Internal Use Only.

isSetE65Cuid

boolean isSetE65Cuid()

Internal Use Only.

setE65Cuid

void setE65Cuid(java.lang.String e65Cuid)

Internal Use Only.

xsetE65Cuid

void xsetE65Cuid(org.apache.xmlbeans.XmlString e65Cuid)

Internal Use Only.

unsetE65Cuid

void unsetE65Cuid()

Internal Use Only.

getUpdateObject

java.lang.String getUpdateObject()

Internal Use Only.

xgetUpdateObject

org.apache.xmlbeans.XmlString xgetUpdateObject()

Internal Use Only.

isSetUpdateObject

boolean isSetUpdateObject()

Internal Use Only.

setUpdateObject

void setUpdateObject(java.lang.String updateObject)

Internal Use Only.

xsetUpdateObject

void xsetUpdateObject(org.apache.xmlbeans.XmlString updateObject)

Internal Use Only.

unsetUpdateObject

void unsetUpdateObject()

Internal Use Only.

getE65Id

java.lang.String getE65Id()

Internal Use Only.

xgetE65Id

org.apache.xmlbeans.XmlString xgetE65Id()

Internal Use Only.

isSetE65Id

boolean isSetE65Id()

Internal Use Only.

setE65Id

void setE65Id(java.lang.String e65Id)

Internal Use Only.

xsetE65Id

void xsetE65Id(org.apache.xmlbeans.XmlString e65Id)

Internal Use Only.

unsetE65Id

void unsetE65Id()

Internal Use Only.

getEpmDocuments

Rtf.EpmDocuments getEpmDocuments()

Internal Use Only.

isSetEpmDocuments

boolean isSetEpmDocuments()

Internal Use Only.

setEpmDocuments

void setEpmDocuments(Rtf.EpmDocuments epmDocuments)

Internal Use Only.

addNewEpmDocuments

Rtf.EpmDocuments addNewEpmDocuments()

Internal Use Only.

unsetEpmDocuments

void unsetEpmDocuments()

Internal Use Only.

getPluginProcessingInterface

ReportProcessingInfo getPluginProcessingInterface()

Internal Use Only.

isSetPluginProcessingInterface

boolean isSetPluginProcessingInterface()

Internal Use Only.

setPluginProcessingInterface

void setPluginProcessingInterface(ReportProcessingInfo pluginProcessingInterface)

Internal Use Only.

addNewPluginProcessingInterface

ReportProcessingInfo addNewPluginProcessingInterface()

Internal Use Only.

unsetPluginProcessingInterface

void unsetPluginProcessingInterface()

Internal Use Only.

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.

getCustomProperties

CustomProperties getCustomProperties()

Returns the custom properties.

Returns:

The custom properties.

isSetCustomProperties

boolean isSetCustomProperties()

Checks if the custom properties have been set.

Returns:

true if the custom properties have been set, and false otherwise.

setCustomProperties

void setCustomProperties(CustomProperties customProperties)

Sets the custom properties.

Parameters:

customProperties - The custom properties.

addNewCustomProperties

CustomProperties addNewCustomProperties()

Appends and returns a new empty CustomProperties element

Returns:

An empty CustomProperties object.

unsetCustomProperties

void unsetCustomProperties()

Deletes or unsets the CustomProperties element.