com.businessobjects.dsws.reportengine
Interface ImageManagement

All Superinterfaces:

CallbackOption

public interface ImageManagement
extends CallbackOption

The ImageManagement interface is used to set a callback script used to view images embedded in a document.
Documents viewed using CharacterView return a stream of a pure HTML. Images are included as HTML links. Use the ImageManagement object to set a callback script used to return images in binary form on the output stream.

Example: Set image management callback script.

 CallbackOption[] boCallOpt = new CallbackOption[1];
 ImageManagement boImgMan = ImageManagement.Factory.newInstance();
 boImgMan.setCallbackScript("getImage.jsp");
 boImgMan.setImageManagementHolder("imageName");
 boImgMan.setDocumentReferenceHolder("docRef");
 boCallOpt[0] = boImgMan;
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOView.setCallbackOptionArray(boCallOpt);
 retBOData.setRetrieveView(retBOView);
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,null,null,retBOData);
 

See Image for an example of an image callback script.

See Also:

Image, CallbackOption, DrillOption, EmbeddedCallbackOption, RetrieveView, CharacterView, RetrieveData, ReportEngine, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getImageManagementHolder() Internal Use Only.
boolean	isSetImageManagementHolder() Checks if the ImageManagementHolder attribute is set.
void	setImageManagementHolder(java.lang.String imageManagementHolder) Sets the name of the parameter in the URL which contains the name of the image to be passed to the callback script.
void	unsetImageManagementHolder() Unsets the ImageManagementHolder attribute.
org.apache.xmlbeans.XmlString	xgetImageManagementHolder() Internal Use Only.
void	xsetImageManagementHolder(org.apache.xmlbeans.XmlString imageManagementHolder) Internal Use Only.

Methods inherited from interface com.businessobjects.dsws.reportengine.CallbackOption

getCallbackFrame, getCallbackScript, getDocumentReferenceHolder, isSetCallbackFrame, isSetCallbackScript, isSetDocumentReferenceHolder, setCallbackFrame, setCallbackScript, setDocumentReferenceHolder, unsetCallbackFrame, unsetCallbackScript, unsetDocumentReferenceHolder, xgetCallbackFrame, xgetCallbackScript, xgetDocumentReferenceHolder, xsetCallbackFrame, xsetCallbackScript, xsetDocumentReferenceHolder

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getImageManagementHolder

java.lang.String getImageManagementHolder()

Internal Use Only.

xgetImageManagementHolder

org.apache.xmlbeans.XmlString xgetImageManagementHolder()

Internal Use Only.

isSetImageManagementHolder

boolean isSetImageManagementHolder()

Checks if the ImageManagementHolder attribute is set.

Returns:

true if the ImageManagementHolder element is set, otherwise false

setImageManagementHolder

void setImageManagementHolder(java.lang.String imageManagementHolder)

Sets the name of the parameter in the URL which contains the name of the image to be passed to the callback script. This parameter is passed to the callback in the URL string.

Example: Retrieve the image name in a callback script.

page1.jsp
DrillOption.setImageManagementHolder("imageName");
viewImage.jsp
String imageName = request.getParameter( "imageName" );


Parameters:

imageManagementHolder - a string containing the holder (parameter) name.

xsetImageManagementHolder

void xsetImageManagementHolder(org.apache.xmlbeans.XmlString imageManagementHolder)

Internal Use Only.

unsetImageManagementHolder

void unsetImageManagementHolder()

Unsets the ImageManagementHolder attribute.