com.crystaldecisions.sdk.occa.infostore
Interface IContent

All Known Subinterfaces:

IExcel, IPDF, IPowerPoint, IReport, IRTF, ITxt, IWord

public interface IContent

This interface defines functions used by desktop plugins that export to a particular file type. This interface is not actually returned by any objects. The only way to access this object and the methods it contains is through casting. Any desktop plugins that allow their files to be exported support this interface (listed below).

Remarks

This example demonstrates how to check if an object supports this interface and then casts it as an IContent object if it is supported:

 if ( obj instanceof IContent )
 {
 	IContent contentObj = (IContent) obj;
 }
 

See Also:

IExcel, IPDF, IRTF, ITxt, IWord

Method Summary

byte[]	getContent() Returns the byte stream which represents the main file of the plugin.
long	getContentLength() Returns a long that represents the length of this IContent object.
java.io.InputStream	getInputStream() Returns an InputStream object of this content.
java.lang.String	getMimeType() Returns the MIME type for the plugin file type.
java.lang.Object	getPluginProcessingInterface(java.lang.String kind) Returns the processing interface for the object.
void	writeContent(java.io.OutputStream output) Writes the content based on the incoming OutputStream object.

Method Detail

getMimeType

public java.lang.String getMimeType()

Returns the MIME type for the plugin file type.

Returns:

The MIME type of the data that will be returned from getContent().

See Also:

IContent.getContent()

getContent

public byte[] getContent()
                  throws SDKException

Returns the byte stream which represents the main file of the plugin.

Returns:

An byte array containing the raw data of the object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getInputStream

public java.io.InputStream getInputStream()
                                   throws SDKException

Returns an InputStream object of this content.

Returns:

An InputStream object of this content.

Throws:

SDKException - This is thrown if the process is unsuccessful.

writeContent

public void writeContent(java.io.OutputStream output)
                  throws SDKException

Writes the content based on the incoming OutputStream object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getContentLength

public long getContentLength()
                      throws SDKException

Returns a long that represents the length of this IContent object.

Returns:

A long that represents the length of this IContent object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPluginProcessingInterface

public java.lang.Object getPluginProcessingInterface(java.lang.String kind)
                                              throws SDKException

Returns the processing interface for the object. This method only applies to objects that can be scheduled.

Parameters:

kind - A String that represents the IInfoObject type.

Returns:

An Object that is one of IReportProcessingInfo or IWebiProcessingInfo.

Throws:

SDKException - This is thrown if the process is unsuccessful.