com.businessobjects.dsws.reportengine
Interface CallbackOption

All Known Subinterfaces:

DrillOption, EmbeddedCallbackOption, ImageManagement

public interface CallbackOption

The CallbackOption is the parent interface for all callback mechanisms. A CallbackOption sets a script that is to be called each time an action or object of a certain type is retrieved with a document view.
Note: If your Web Services consumer application uses HTML frames, it is possible to set the frame in which the callback script will be run.

Example: Setting the DrillOption to CallbackOption.

 DrillOption objDrillOption = DrillOption.Factory.newInstance();
 objDrillOption.setCallbackFrame("view");
 objDrillOption.setCallbackScript("manageDrill.jsp");
 objDrillOption.setAmbiguousDrillCallbackScript("ambiguous.jsp");
 objDrillOption.setBlockHolder("block");
 objDrillOption.setFromHolder("from");
 objDrillOption.setDrillActionHolder("action");
 objDrillOption.setFilterHolder("filter");
 objDrillOption.setToHolder("to");
 objDrillOption.setHierarchyHolder("hierarchy");
 objDrillOption.setDocumentReferenceHolder("referenceHolder");

 CallbackOption[] aobjCallbackOptions = new CallbackOption[1];
 aobjCallbackOptions[0] = objDrillOption;
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOView.setCallbackOptionArray(aobjCallbackOptions);
 

See Also:

DrillOption, EmbeddedCallbackOption, ImageManagement, RetrieveView, RetrieveData, ReportEngine, DocumentInformation

Nested Class Summary

static class

CallbackOption.Factory A class with methods for creating instances of the CallbackOption type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getCallbackFrame() Internal Use Only.
java.lang.String	getCallbackScript() Internal Use Only.
java.lang.String	getDocumentReferenceHolder() Internal Use Only.
boolean	isSetCallbackFrame() Checks if the CallbackFrame attribute is set.
boolean	isSetCallbackScript() Checks if the CallbackScript attribute is set.
boolean	isSetDocumentReferenceHolder() Checks if the DocumentReferenceHolder attribute is set.
void	setCallbackFrame(java.lang.String callbackFrame) Sets the name of the frame in which the callback script is to be executed.
void	setCallbackScript(java.lang.String callbackScript) Sets the name of the script that has to be called.
void	setDocumentReferenceHolder(java.lang.String documentReferenceHolder) Sets the name of the parameter in the URL containing the DocumentReference set after executing the action specified in the callback script.
void	unsetCallbackFrame() Unsets the CallbackFrame attribute.
void	unsetCallbackScript() Unsets the CallbackScript attribute
void	unsetDocumentReferenceHolder() Unsets the DocumentReferenceHolder attribute
org.apache.xmlbeans.XmlString	xgetCallbackFrame() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetCallbackScript() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDocumentReferenceHolder() Internal Use Only.
void	xsetCallbackFrame(org.apache.xmlbeans.XmlString callbackFrame) Internal Use Only.
void	xsetCallbackScript(org.apache.xmlbeans.XmlString callbackScript) Internal Use Only.
void	xsetDocumentReferenceHolder(org.apache.xmlbeans.XmlString documentReferenceHolder) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getCallbackScript

java.lang.String getCallbackScript()

Internal Use Only.

xgetCallbackScript

org.apache.xmlbeans.XmlString xgetCallbackScript()

Internal Use Only.

isSetCallbackScript

boolean isSetCallbackScript()

Checks if the CallbackScript attribute is set.

Returns:

true, if the CallbackScript element is set, otherwise false.

setCallbackScript

void setCallbackScript(java.lang.String callbackScript)

Sets the name of the script that has to be called.
Note: The script name can be:

• Simple, for example:
  "drill.jsp".
• Complex and contain variables to be used by the callback script, for example:
  http://www.myserver.com/wijsp/drill.jsp?reportname=test

Parameters:

callbackScript - the name of the callback script with variables if necessary.

xsetCallbackScript

void xsetCallbackScript(org.apache.xmlbeans.XmlString callbackScript)

Internal Use Only.

unsetCallbackScript

void unsetCallbackScript()

Unsets the CallbackScript attribute

getCallbackFrame

java.lang.String getCallbackFrame()

Internal Use Only.

xgetCallbackFrame

org.apache.xmlbeans.XmlString xgetCallbackFrame()

Internal Use Only.

isSetCallbackFrame

boolean isSetCallbackFrame()

Checks if the CallbackFrame attribute is set.

Returns:

true, if the CallbackFrame attribute is set, otherwise false

setCallbackFrame

void setCallbackFrame(java.lang.String callbackFrame)

Sets the name of the frame in which the callback script is to be executed.
Note: It is not necessary for callback scripts to run in a separate frame.

Parameters:

callbackFrame - the name of the frame in which the callback script is to be run. Possibilities are:

• _blank: Load the linked document into an unnamed new blank window.
• _parent: Load the linked document into the immediate parent of the document containing the link.
• _self: Default. Load the linked document into the window in which the link was clicked, that is to say the active window.
• _top: Load the linked document into the top most window.
• name: The name of the target window or frame. For example, "myFrame".

See Also:

ImageManagement

xsetCallbackFrame

void xsetCallbackFrame(org.apache.xmlbeans.XmlString callbackFrame)

Internal Use Only.

unsetCallbackFrame

void unsetCallbackFrame()

Unsets the CallbackFrame attribute.

getDocumentReferenceHolder

java.lang.String getDocumentReferenceHolder()

Internal Use Only.

xgetDocumentReferenceHolder

org.apache.xmlbeans.XmlString xgetDocumentReferenceHolder()

Internal Use Only.

isSetDocumentReferenceHolder

boolean isSetDocumentReferenceHolder()

Checks if the DocumentReferenceHolder attribute is set.

Returns:

true, if the DocumentReferenceHolder attribute is set, otherwise false

setDocumentReferenceHolder

void setDocumentReferenceHolder(java.lang.String documentReferenceHolder)

Sets the name of the parameter in the URL containing the DocumentReference set after executing the action specified in the callback script.
A document’s reference is used to store and later reconstruct the state of a document. When a user opens a document, Web Services generates a reference. As the document changes, the reference generates temporary files representing the document’s states. This allows users to navigate backward and forward through the document states, that is to say undo and redo actions. The storage token lasts as long as its BusinessObjects Web Service session.
By calling getDocumentReferenceHolder, the documents reference can be recovered using the getParameter function.

Example: Retrieve a document reference.

page1.jsp
CallbackOption.setDocumentReferenceHolder("docRef");
callbackScript.jsp
String docRef = request.getParameter( "docRef" );


Parameters:

documentReferenceHolder - A string containing the DocumentReferenceHolder name.

xsetDocumentReferenceHolder

void xsetDocumentReferenceHolder(org.apache.xmlbeans.XmlString documentReferenceHolder)

Internal Use Only.

unsetDocumentReferenceHolder

void unsetDocumentReferenceHolder()

Unsets the DocumentReferenceHolder attribute