com.businessobjects.dsws.reportengine
Interface Image

public interface Image

The Image interface is used to return an image.

Example: An image callback script.

 String strImageName = request.getParameter("imageName");
 String strDocReference = request.getParameter("reference");
 if (null != strImageName)
 {
        Image theImage =  boRepEng.getImage(strDocReference, strImageName);
        response.setContentType(theImage.getMimeType());
                ServletOutputStream Output = response.getOutputStream();
                byte[] imageData = theImage.getBinaryContent();
                response.setContentLength(imageData.length);
                Output.write(imageData);
                Output.close();
 }
 

See ImageManagement for an example of how to set an image callback script.

See Also:

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

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

byte[]	getContent() Returns the binary contents of an image.
java.lang.String	getMimeType() Returns the mime type of the image.
java.lang.String	getName() Returns the name of the image.
boolean	isSetContent() Checks if the Content element is set.
boolean	isSetMimeType() Checks if the MimeType attribute is set.
boolean	isSetName() Checks if the Name attribute is set.
void	setContent(byte[] content) Internal Use Only.
void	setMimeType(java.lang.String mimeType) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	unsetContent() Internal Use Only.
void	unsetMimeType() Internal Use Only.
void	unsetName() Internal Use Only.
org.apache.xmlbeans.XmlBase64Binary	xgetContent() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetMimeType() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetContent(org.apache.xmlbeans.XmlBase64Binary content) Internal Use Only.
void	xsetMimeType(org.apache.xmlbeans.XmlString mimeType) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getContent

byte[] getContent()

Returns the binary contents of an image.

Returns:

the binary contents of an image.

See Also:

Image, ImageManagement

xgetContent

org.apache.xmlbeans.XmlBase64Binary xgetContent()

Internal Use Only.

isSetContent

boolean isSetContent()

Checks if the Content element is set.

Returns:

true if the Content element is set, otherwise false

setContent

void setContent(byte[] content)

Internal Use Only.

xsetContent

void xsetContent(org.apache.xmlbeans.XmlBase64Binary content)

Internal Use Only.

unsetContent

void unsetContent()

Internal Use Only.

getMimeType

java.lang.String getMimeType()

Returns the mime type of the image.

For a list of possible mime types, see getMimeType.

Returns:

the image's mime type.

See Also:

Image, ImageManagement

xgetMimeType

org.apache.xmlbeans.XmlString xgetMimeType()

Internal Use Only.

isSetMimeType

boolean isSetMimeType()

Checks if the MimeType attribute is set.

Returns:

true if the Mimetype element is set, otherwise false

setMimeType

void setMimeType(java.lang.String mimeType)

Internal Use Only.

xsetMimeType

void xsetMimeType(org.apache.xmlbeans.XmlString mimeType)

Internal Use Only.

unsetMimeType

void unsetMimeType()

Internal Use Only.

getName

java.lang.String getName()

Returns the name of the image.

Returns:

the name of the image.

See Also:

Image, ImageManagement

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

isSetName

boolean isSetName()

Checks if the Name attribute is set.

Returns:

true if the name element is set, otherwise false

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

unsetName

void unsetName()

Internal Use Only.