Enterprise Information Portal APIs

com.ibm.mm.viewer
Class CMBStreamingDocServicesCallbacks

java.lang.Object
  |
  +--com.ibm.mm.viewer.CMBStreamingDocServicesCallbacks

public abstract class CMBStreamingDocServicesCallbacks
extends java.lang.Object

CMBStreamingDocServicesCallbacks defines methods that users of CMBStreamingDocServices must implement to handle requests for additional information and tracing.

Since:
7.1
See Also:
CMBStreamingDocServices

Constructor Summary
CMBStreamingDocServicesCallbacks()
           
 
Method Summary
abstract  java.io.InputStream getAnnotation(CMBDocument document, int annotationNumber)
          Callback method to retrieve an annotation blob of a document.
abstract  java.io.InputStream getForm(CMBDocument document, java.lang.String formName)
          Callback method to retrieve the background form for a document.
 int getFormSize(CMBDocument document, java.lang.String formName)
          Callback method to retrieve the form size.
abstract  java.io.InputStream getPart(CMBDocument document, int partNumber, java.lang.StringBuffer outMimeType)
          Callback method to retrieve another part of a multi-part document.
 int getPartSize(CMBDocument document, int partNumber)
          Callback method to retrieve the size of the part specified by the part number.
abstract  java.io.InputStream getResources(CMBDocument document)
          Callback method to retrieve the resources of a document.
abstract  void trace(java.lang.String message)
          Writes a trace message.
abstract  boolean traceEnabled()
          Returns true if tracing is enabled.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBStreamingDocServicesCallbacks

public CMBStreamingDocServicesCallbacks()
Method Detail

getForm

public abstract java.io.InputStream getForm(CMBDocument document,
                                            java.lang.String formName)
Callback method to retrieve the background form for a document.
Parameters:
document - the document whose form is being retrieved.
formName - the name of the form. This could be a file name, url, or other unique id.

getFormSize

public int getFormSize(CMBDocument document,
                       java.lang.String formName)
Callback method to retrieve the form size.
Parameters:
document - the document whose form size is being retrieved.
formName - the name of the form

getPart

public abstract java.io.InputStream getPart(CMBDocument document,
                                            int partNumber,
                                            java.lang.StringBuffer outMimeType)
Callback method to retrieve another part of a multi-part document.
Parameters:
document - the document for which an additional part is being retrieved.
partNumber - the sequential number of the part (first part being zero).
outMimeType - out parameter in which the mime type of the part is returned. can be null if caller is not interested in the mime type of the part

getPartSize

public int getPartSize(CMBDocument document,
                       int partNumber)
Callback method to retrieve the size of the part specified by the part number.
Parameters:
document - the document for which an additional part is being retrieved.
partNumber - the index of the part (zero is the first part)
Returns:
int the part size or 0 if size is unknown.

getAnnotation

public abstract java.io.InputStream getAnnotation(CMBDocument document,
                                                  int annotationNumber)
Callback method to retrieve an annotation blob of a document.
Parameters:
document - the document for which an annotation blob is being retrieved.
annotationNumber - the sequential number of the annotation (first annotation being zero).

getResources

public abstract java.io.InputStream getResources(CMBDocument document)
Callback method to retrieve the resources of a document. Resources are typically shared background images for pages of the document.
Parameters:
document - the document for which the resources are being retrieved.

traceEnabled

public abstract boolean traceEnabled()
Returns true if tracing is enabled.

trace

public abstract void trace(java.lang.String message)
Writes a trace message.

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.