com.businessobjects.enterprise.webi
Interface Webi

All Superinterfaces:
InfoObject

public interface Webi
extends InfoObject

Contains properties and methods that allow you to manage a Web Intelligence document.


Nested Class Summary
static class Webi.Factory
          A class with methods for creating instances of the Webi 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.
 CustomProperties addNewCustomProperties()
          Appends and returns a new empty CustomProperties object.
 EncyclopediaTopics addNewEncyclopediaTopics()
          Internal Use Only.
 FileProperties addNewFileProperties()
          Appends and returns a new empty FileProperties object.
 FullClients addNewFullClients()
          Internal Use Only.
 PersonalCategories addNewPersonalCategories()
          Appends and returns a new empty PersonalCategories object.
 SchedulingInfo addNewSchedulingInfo()
          Appends and returns a new empty SchedulingInfo object.
 WebiProcessingInfo addNewWebiProcessingInfo()
          Appends and returns a new empty WebiProcessingInfo object.
 AnalyticActivities getAnalyticActivities()
          Internal Use Only.
 java.lang.String getAuthor()
          Returns the document owner.
 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 InfoObject's associated files.
 FullClients getFullClients()
          Internal Use Only.
 PersonalCategories getPersonalCategories()
          Returns the ID set of top-level personal categories that have been assigned to the object.
 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.
 WebiProcessingInfo getWebiProcessingInfo()
          Returns the Web Intelligence document properties.
 boolean isSetAnalyticActivities()
          Internal Use Only.
 boolean isSetAuthor()
          Checks if the document owner has been set.
 boolean isSetCorporateCategories()
          Checks if the ID set of top-level categories has been set.
 boolean isSetCustomProperties()
          Checks if the custom properties have been set.
 boolean isSetEncyclopediaTopics()
          Internal Use Only.
 boolean isSetFileProperties()
          Checks if the InfoObject's associated files have been set.
 boolean isSetFullClients()
          Internal Use Only.
 boolean isSetPersonalCategories()
          Checks if the ID set of top-level personal categories has been set.
 boolean isSetProcessingProgID()
          Internal Use Only.
 boolean isSetSchedulingInfo()
          Checks if the scheduling information has been set.
 boolean isSetViewerURL()
          Checks if the viewer URL to be associated with an alert that will be included in the alert notification email has been set.
 boolean isSetWebiProcessingInfo()
          Checks if the Web Intelligence document properties have been set.
 void setAnalyticActivities(AnalyticActivities analyticActivities)
          Internal Use Only.
 void setAuthor(java.lang.String author)
          Sets the document owner.
 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 InfoObject's associated files.
 void setFullClients(FullClients fullClients)
          Internal Use Only.
 void setPersonalCategories(PersonalCategories personalCategories)
          Sets the ID set of top-level personal categories.
 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)
           Sets the viewer URL associated with an alert that will be included in the alert notification email.
 void setWebiProcessingInfo(WebiProcessingInfo webiProcessingInfo)
          Sets the Web Intelligence document properties.
 void unsetAnalyticActivities()
          Internal Use Only.
 void unsetAuthor()
          Deletes or unsets the Author 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 unsetFullClients()
          Internal Use Only.
 void unsetPersonalCategories()
          Deletes or unsets the PersonalCategories element.
 void unsetProcessingProgID()
          Internal Use Only.
 void unsetSchedulingInfo()
          Deletes or unsets the SchedulingInfo element.
 void unsetViewerURL()
          Deletes or unsets the ViewerURL element.
 void unsetWebiProcessingInfo()
          Deletes or unsets the WebiProcessingInfo element.
 org.apache.xmlbeans.XmlString xgetAuthor()
          Internal Use Only.
 org.apache.xmlbeans.XmlString xgetProcessingProgID()
          Internal Use Only.
 org.apache.xmlbeans.XmlString xgetViewerURL()
          Internal Use Only.
 void xsetAuthor(org.apache.xmlbeans.XmlString author)
          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, addNewMultilingualDescriptions, addNewMultilingualNames, addNewPluginInfo, addNewRolesOnObject, addNewSecurityInfo, addNewSecurityInfo2, addNewSharedDoc, getAlerts, getChildrenObjects, getCreationTime, getCUID, getDescription, getEndTime, getErrorMessage, getGUID, getID, getInstance, getInstanceObject, getIsApplicationObject, getIsComponent, getIsHiddenObject, getIsPluginObject, getIsRecurring, getIsRunnableObject, getIsSendable, getIsSystemObject, getKey, getKeywords, getKind, getLastRunTime, getLastSuccessfulInstanceCUID, getMultilingualDescriptions, getMultilingualNames, getName, getNewJobID, getNextRunTime, getObjectIsContainer, getOwner, getOwnerCUID, getParentCUID, getPluginInfo, getRolesOnObject, getRUID, getSchedulable, getSecurityInfo, getSecurityInfo2, getSharedDoc, getStartTime, getUiStatus, getUpdateTime, isSetAlerts, isSetChildrenObjects, isSetCreationTime, isSetCUID, isSetDescription, isSetEndTime, isSetErrorMessage, isSetGUID, isSetID, isSetInstance, isSetInstanceObject, isSetIsApplicationObject, isSetIsComponent, isSetIsHiddenObject, isSetIsPluginObject, isSetIsRecurring, isSetIsRunnableObject, isSetIsSendable, isSetIsSystemObject, isSetKey, isSetKeywords, isSetKind, isSetLastRunTime, isSetLastSuccessfulInstanceCUID, isSetMultilingualDescriptions, isSetMultilingualNames, isSetNewJobID, isSetNextRunTime, isSetObjectIsContainer, isSetOwner, isSetOwnerCUID, isSetParentCUID, isSetPluginInfo, isSetRolesOnObject, isSetRUID, isSetSchedulable, isSetSecurityInfo, isSetSecurityInfo2, isSetSharedDoc, isSetStartTime, isSetUiStatus, isSetUpdateTime, setAlerts, setChildrenObjects, setCreationTime, setCUID, setDescription, setEndTime, setErrorMessage, setGUID, setID, setInstance, setInstanceObject, setIsApplicationObject, setIsComponent, setIsHiddenObject, setIsPluginObject, setIsRecurring, setIsRunnableObject, setIsSendable, setIsSystemObject, setKey, setKeywords, setKind, setLastRunTime, setLastSuccessfulInstanceCUID, setMultilingualDescriptions, setMultilingualNames, setName, setNewJobID, setNextRunTime, setObjectIsContainer, setOwner, setOwnerCUID, setParentCUID, setPluginInfo, setRolesOnObject, setRUID, setSchedulable, setSecurityInfo, setSecurityInfo2, setSharedDoc, setStartTime, setUiStatus, setUpdateTime, unsetAlerts, unsetChildrenObjects, unsetCreationTime, unsetCUID, unsetDescription, unsetEndTime, unsetErrorMessage, unsetGUID, unsetID, unsetInstance, unsetInstanceObject, unsetIsApplicationObject, unsetIsComponent, unsetIsHiddenObject, unsetIsPluginObject, unsetIsRecurring, unsetIsRunnableObject, unsetIsSendable, unsetIsSystemObject, unsetKey, unsetKeywords, unsetKind, unsetLastRunTime, unsetLastSuccessfulInstanceCUID, unsetMultilingualDescriptions, unsetMultilingualNames, unsetNewJobID, unsetNextRunTime, unsetObjectIsContainer, unsetOwner, unsetOwnerCUID, unsetParentCUID, unsetPluginInfo, unsetRolesOnObject, unsetRUID, unsetSchedulable, unsetSecurityInfo, unsetSecurityInfo2, unsetSharedDoc, unsetStartTime, unsetUiStatus, unsetUpdateTime, xgetChildrenObjects, xgetCreationTime, xgetCUID, xgetDescription, xgetEndTime, xgetErrorMessage, xgetGUID, 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, xsetGUID, 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

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 has been set.

Returns:
true if the SchedulingInfo element 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 FileProperties element has 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 has been set.

Returns:
true if the CorporateCategories element 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 has been set.

Returns:
true if the PersonalCategories element 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()
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.


getFullClients

FullClients getFullClients()
Internal Use Only.


isSetFullClients

boolean isSetFullClients()
Internal Use Only.


setFullClients

void setFullClients(FullClients fullClients)
Internal Use Only.


addNewFullClients

FullClients addNewFullClients()
Internal Use Only.


unsetFullClients

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

Returns:
true if the ViewerURL element 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.


getAuthor

java.lang.String getAuthor()

Returns the document owner.

Returns:
A String that indicates the document owner.

xgetAuthor

org.apache.xmlbeans.XmlString xgetAuthor()
Internal Use Only.


isSetAuthor

boolean isSetAuthor()
Checks if the document owner has been set.

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

setAuthor

void setAuthor(java.lang.String author)

Sets the document owner.

Parameters:
author - A String that indicates the document owner.

xsetAuthor

void xsetAuthor(org.apache.xmlbeans.XmlString author)
Internal Use Only.


unsetAuthor

void unsetAuthor()
Deletes or unsets the Author element.


getWebiProcessingInfo

WebiProcessingInfo getWebiProcessingInfo()

Returns the Web Intelligence document properties.

Returns:
The Web Intelligence document properties.

isSetWebiProcessingInfo

boolean isSetWebiProcessingInfo()
Checks if the Web Intelligence document properties have been set.

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

setWebiProcessingInfo

void setWebiProcessingInfo(WebiProcessingInfo webiProcessingInfo)

Sets the Web Intelligence document properties.

Parameters:
webiProcessingInfo - The Web Intelligence document properties.

addNewWebiProcessingInfo

WebiProcessingInfo addNewWebiProcessingInfo()

Appends and returns a new empty WebiProcessingInfo object.

Returns:
An empty WebiProcessingInfo object.

unsetWebiProcessingInfo

void unsetWebiProcessingInfo()
Deletes or unsets the WebiProcessingInfo 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.


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 CustomProperties element has 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 object.

Returns:
An empty CustomProperties object.

unsetCustomProperties

void unsetCustomProperties()
Deletes or unsets the CustomProperties element.