com.businessobjects.enterprise.excel
Interface Excel

All Superinterfaces:
InfoObject

public interface Excel
extends InfoObject

Allows you to view reports formatted as Excel spreadsheets. When the report runs, it creates an Excel object in the CMS InfoStore.


Nested Class Summary
static class Excel.Factory
          A class with methods for creating instances of the Excel type.
 
Field Summary
static org.apache.xmlbeans.SchemaType type
          Internal Use Only.
 
Method Summary
 AnalyticActivities addNewAnalyticActivities()
          Internal Use Only.
 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()
          Appends and returns a new empty FileProperties 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.
 DocumentProcessingInfo addNewPluginProcessingInterface()
          Internal Use Only.
 SchedulingInfo addNewSchedulingInfo()
          Appends and returns a new empty SchedulingInfo object to the last element of the array.
 AnalyticActivities getAnalyticActivities()
          Internal Use Only.
 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.
 EncyclopediaTopics getEncyclopediaTopics()
          Internal Use Only.
 FileProperties getFileProperties()
          Returns the files associated with InfoObject.
 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.
 DocumentProcessingInfo getPluginProcessingInterface()
          Internal Use Only.
 java.lang.String getProcessingProgID()
          Internal Use Only.
 SchedulingInfo getSchedulingInfo()
          Returns the scheduling information for the object.
 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 isSetCorporateCategories()
          Checks if the CorporateCategories has been set.
 boolean isSetCustomProperties()
          Checks if the CustomProperties has been set.
 boolean isSetE65Cuid()
          Internal Use Only.
 boolean isSetEncyclopediaTopics()
          Internal Use Only.
 boolean isSetFileProperties()
          Checks if the FileProperties has been set.
 boolean isSetMimeType()
          Internal Use Only.
 boolean isSetPersonalCategories()
          Checks if the PersonalCategories has been set.
 boolean isSetPluginProcessingInterface()
          Internal Use Only.
 boolean isSetProcessingProgID()
          Internal Use Only.
 boolean isSetSchedulingInfo()
          Checks if the SchedulingInfo has been set.
 boolean isSetViewerURL()
          Checks if the ViewerURL has been set.
 void setAnalyticActivities(AnalyticActivities analyticActivities)
          Internal Use Only.
 void setCorporateCategories(CorporateCategories corporateCategories)
          Sets the ID of top-level categories that have been assigned to the object.
 void setCustomProperties(CustomProperties customProperties)
          Sets the custom properties.
 void setE65Cuid(java.lang.String e65Cuid)
          Internal Use Only.
 void setEncyclopediaTopics(EncyclopediaTopics encyclopediaTopics)
          Internal Use Only.
 void setFileProperties(FileProperties fileProperties)
          Sets the files associated with InfoObject.
 void setMimeType(java.lang.String mimeType)
          Internal Use Only.
 void setPersonalCategories(PersonalCategories personalCategories)
          Sets the IDs of the top-level personal categories that have been assigned to the object.
 void setPluginProcessingInterface(DocumentProcessingInfo 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 setViewerURL(java.lang.String viewerURL)
          Returns the viewer URL associated with an alert that will be included in the alert notification email.
 void unsetAnalyticActivities()
          Internal Use Only.
 void unsetCorporateCategories()
          Deletes or unsets the CorporateCategories element.
 void unsetCustomProperties()
          Deletes or unsets the CustomProperties element.
 void unsetE65Cuid()
          Internal Use Only.
 void unsetEncyclopediaTopics()
          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 unsetViewerURL()
          Deletes or unsets the ViewerURL element.
 org.apache.xmlbeans.XmlString xgetE65Cuid()
          Internal Use Only.
 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 xsetE65Cuid(org.apache.xmlbeans.XmlString e65Cuid)
          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 - The 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 object.

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 has 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()
Appends and returns a new empty FileProperties object to the last element of the array.

Returns:
A new FileProperties.

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:
The CorporateCategories object.

isSetCorporateCategories

boolean isSetCorporateCategories()
Checks if the CorporateCategories has been set.

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

setCorporateCategories

void setCorporateCategories(CorporateCategories corporateCategories)
Sets the ID of top-level categories that have been assigned to the object.

Parameters:
corporateCategories - The CorporateCategories 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 PersonalCategories object.

isSetPersonalCategories

boolean isSetPersonalCategories()
Checks if the PersonalCategories has been set.

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

setPersonalCategories

void setPersonalCategories(PersonalCategories personalCategories)
Sets the IDs of the top-level personal categories that have been assigned to the object.

Parameters:
personalCategories - A PersonalCategories 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.


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%

Returns:
A String representing the URL for the viewer.

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)

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%

Parameters:
viewerURL - A String representing the URL for the viewer.

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.


getPluginProcessingInterface

DocumentProcessingInfo getPluginProcessingInterface()
Internal Use Only.


isSetPluginProcessingInterface

boolean isSetPluginProcessingInterface()
Internal Use Only.


setPluginProcessingInterface

void setPluginProcessingInterface(DocumentProcessingInfo pluginProcessingInterface)
Internal Use Only.


addNewPluginProcessingInterface

DocumentProcessingInfo 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 CustomProperties 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.