com.crystaldecisions.sdk.plugin.desktop.report
Interface IReportGlobal


public interface IReportGlobal

This interface allows you to set properties that are general for all report objects in BusinessObjects Enterprise.

Note: There are a couple of items to take into account when retrieving the ReportGlobal plugin. For example:

 IInfoObjects infoObjs = iStore.query("SELECT SI_PROCESSING_EXTENSIONS FROM CI_SYSTEMOBJECTS 
 	WHERE SI_PARENTID = 27 AND SI_NAME = 'CrystalEnterprise.Report'");
 
 for ( int i = 0 ; i < infoObjs.size(); i++ )
 {
     IReportGlobal reportGlobal = (IReportGlobal) infoObjs.get(i);
 }
 


Method Summary
 java.lang.String getEmbeddedLinkURL()
           Returns the default report viewing URL location.
 IProcessingExtensions getProcessingExtensions()
           Returns the complete list of processing extensions available in the system.
 void setEmbeddedLinkURL(java.lang.String strURL)
           Sets the default report viewing URL location.
 

Method Detail

getProcessingExtensions

public IProcessingExtensions getProcessingExtensions()
                                              throws SDKException

Returns the complete list of processing extensions available in the system.

Returns:
An IProcessingExtensions object containing the complete list of processing extensions available in the system.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getEmbeddedLinkURL

public java.lang.String getEmbeddedLinkURL()
                                    throws SDKException

Returns the default report viewing URL location. The 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 specifying the default report viewing URL location.
Throws:
SDKException - This is thrown if this object is not a global report object.

setEmbeddedLinkURL

public void setEmbeddedLinkURL(java.lang.String strURL)
                        throws SDKException

Sets the default report viewing URL location. The 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%.

Once you have set this default viewer URL location, you can use it when adding a viewer hyperlink to the message body of an email (for example, when scheduling a report to SMTP, or when sending an alert notification email). Rather than re-typing the default viewer URL location, specify it in the following way: %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:
strURL - A String specifying the default report viewing URL location.
Throws:
SDKException - This is thrown if this object is not a global report object.