|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Webi
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. |
| Field Detail |
|---|
static final org.apache.xmlbeans.SchemaType type
| Method Detail |
|---|
SchedulingInfo getSchedulingInfo()
Returns the scheduling information for the object. It will be an empty reference if the object does not support scheduling.
SchedulingInfo object containing this object's scheduling information.boolean isSetSchedulingInfo()
true if the SchedulingInfo element has been set, and false otherwise.void setSchedulingInfo(SchedulingInfo schedulingInfo)
Sets the scheduling information for the object.
schedulingInfo - A SchedulingInfo object containing this object's scheduling information.SchedulingInfo addNewSchedulingInfo()
Appends and returns a new empty SchedulingInfo object.
SchedulingInfo object.void unsetSchedulingInfo()
FileProperties getFileProperties()
Returns the InfoObject's associated files.
boolean isSetFileProperties()
true if the FileProperties element has been set, and false otherwise.void setFileProperties(FileProperties fileProperties)
Sets the InfoObject's associated files.
fileProperties - The InfoObject's associated files.FileProperties addNewFileProperties()
Appends and returns a new empty FileProperties object.
FileProperties object.void unsetFileProperties()
CorporateCategories getCorporateCategories()
Returns the ID set of top-level categories that have been assigned to the object.
boolean isSetCorporateCategories()
true if the CorporateCategories element has been set, and false otherwise.void setCorporateCategories(CorporateCategories corporateCategories)
Sets the ID set of top-level categories.
corporateCategories - A set of category IDs that have been assigned to the object.CorporateCategories addNewCorporateCategories()
Appends and returns a new empty CorporateCategories object.
CorporateCategories object.void unsetCorporateCategories()
PersonalCategories getPersonalCategories()
Returns the ID set of top-level personal categories that have been assigned to the object.
boolean isSetPersonalCategories()
true if the PersonalCategories element has been set, and false otherwise.void setPersonalCategories(PersonalCategories personalCategories)
Sets the ID set of top-level personal categories.
personalCategories - A set of category IDs that have been assigned to the object.PersonalCategories addNewPersonalCategories()
Appends and returns a new empty PersonalCategories object.
PersonalCategories object.void unsetPersonalCategories()
EncyclopediaTopics getEncyclopediaTopics()
boolean isSetEncyclopediaTopics()
void setEncyclopediaTopics(EncyclopediaTopics encyclopediaTopics)
EncyclopediaTopics addNewEncyclopediaTopics()
void unsetEncyclopediaTopics()
AnalyticActivities getAnalyticActivities()
boolean isSetAnalyticActivities()
void setAnalyticActivities(AnalyticActivities analyticActivities)
AnalyticActivities addNewAnalyticActivities()
void unsetAnalyticActivities()
FullClients getFullClients()
boolean isSetFullClients()
void setFullClients(FullClients fullClients)
FullClients addNewFullClients()
void unsetFullClients()
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).
String containing the viewer URL associated with an alert that will be included in the alert notification email.org.apache.xmlbeans.XmlString xgetViewerURL()
boolean isSetViewerURL()
true if the ViewerURL element has been set, and false otherwise.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).
viewerURL - A String containing the viewer URL associated with an alert that will be included in the alert notification email.void xsetViewerURL(org.apache.xmlbeans.XmlString viewerURL)
void unsetViewerURL()
java.lang.String getAuthor()
Returns the document owner.
String that indicates the document owner.org.apache.xmlbeans.XmlString xgetAuthor()
boolean isSetAuthor()
true if the Author element has been set, and false otherwise.void setAuthor(java.lang.String author)
Sets the document owner.
author - A String that indicates the document owner.void xsetAuthor(org.apache.xmlbeans.XmlString author)
void unsetAuthor()
WebiProcessingInfo getWebiProcessingInfo()
Returns the Web Intelligence document properties.
boolean isSetWebiProcessingInfo()
true if the WebiProcessingInfo element has been set, and false otherwise.void setWebiProcessingInfo(WebiProcessingInfo webiProcessingInfo)
Sets the Web Intelligence document properties.
webiProcessingInfo - The Web Intelligence document properties.WebiProcessingInfo addNewWebiProcessingInfo()
Appends and returns a new empty WebiProcessingInfo object.
WebiProcessingInfo object.void unsetWebiProcessingInfo()
java.lang.String getProcessingProgID()
org.apache.xmlbeans.XmlString xgetProcessingProgID()
boolean isSetProcessingProgID()
void setProcessingProgID(java.lang.String processingProgID)
void xsetProcessingProgID(org.apache.xmlbeans.XmlString processingProgID)
void unsetProcessingProgID()
CustomProperties getCustomProperties()
Returns the custom properties.
boolean isSetCustomProperties()
true if the CustomProperties element has been set, and false otherwise.void setCustomProperties(CustomProperties customProperties)
Sets the custom properties.
customProperties - The custom properties.CustomProperties addNewCustomProperties()
Appends and returns a new empty CustomProperties object.
CustomProperties object.void unsetCustomProperties()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||